-
Notifications
You must be signed in to change notification settings - Fork 133
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(shorebird_cli): add api.shorebird.dev access validator (#2491)
- Loading branch information
Showing
4 changed files
with
110 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
25 changes: 25 additions & 0 deletions
25
packages/shorebird_cli/lib/src/validators/shorebird_api_access_validator.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
import 'dart:io'; | ||
|
||
import 'package:shorebird_cli/src/http_client/http_client.dart'; | ||
import 'package:shorebird_cli/src/validators/validators.dart'; | ||
|
||
/// Verifies that the user has access to api.shorebird.dev. | ||
class ShorebirdApiAccessValidator extends Validator { | ||
@override | ||
String get description => 'Has access to api.shorebird.dev'; | ||
|
||
@override | ||
Future<List<ValidationIssue>> validate() async { | ||
final uri = Uri.parse('https://api.shorebird.dev'); | ||
final result = await httpClient.get(uri); | ||
if (result.statusCode != HttpStatus.ok) { | ||
return [ | ||
const ValidationIssue( | ||
severity: ValidationIssueSeverity.error, | ||
message: 'Unable to access api.shorebird.dev', | ||
), | ||
]; | ||
} | ||
return []; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
83 changes: 83 additions & 0 deletions
83
packages/shorebird_cli/test/src/validators/shorebird_api_access_validator_test.dart
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
import 'dart:io'; | ||
|
||
import 'package:http/http.dart' as http; | ||
import 'package:mocktail/mocktail.dart'; | ||
import 'package:scoped_deps/scoped_deps.dart'; | ||
import 'package:shorebird_cli/src/http_client/http_client.dart'; | ||
import 'package:shorebird_cli/src/validators/validators.dart'; | ||
import 'package:test/test.dart'; | ||
|
||
import '../mocks.dart'; | ||
|
||
void main() { | ||
group(ShorebirdApiAccessValidator, () { | ||
late http.Client httpClient; | ||
late ShorebirdApiAccessValidator validator; | ||
|
||
R runWithOverrides<R>(R Function() body) { | ||
return runScoped( | ||
() => body(), | ||
values: { | ||
httpClientRef.overrideWith(() => httpClient), | ||
}, | ||
); | ||
} | ||
|
||
setUpAll(() { | ||
registerFallbackValue(Uri()); | ||
}); | ||
|
||
setUp(() { | ||
httpClient = MockHttpClient(); | ||
validator = ShorebirdApiAccessValidator(); | ||
|
||
when(() => httpClient.get(any())).thenAnswer( | ||
(_) async => http.Response('', HttpStatus.ok), | ||
); | ||
}); | ||
|
||
group('description', () { | ||
test('has a non-empty description', () { | ||
expect(validator.description, isNotEmpty); | ||
}); | ||
}); | ||
|
||
group('validate', () { | ||
group('when url is accessible', () { | ||
setUp(() { | ||
when(() => httpClient.get(any())).thenAnswer( | ||
(_) async => http.Response('', HttpStatus.ok), | ||
); | ||
}); | ||
|
||
test('returns empty list of validation issues', () async { | ||
final results = await runWithOverrides(validator.validate); | ||
expect(results, isEmpty); | ||
}); | ||
}); | ||
|
||
group('when url is inaccessible', () { | ||
setUp(() { | ||
when(() => httpClient.get(any())).thenAnswer( | ||
(_) async => http.Response('Not Found', HttpStatus.notFound), | ||
); | ||
}); | ||
|
||
test('returns validation error', () async { | ||
final results = await runWithOverrides(validator.validate); | ||
expect( | ||
results, | ||
equals( | ||
[ | ||
const ValidationIssue( | ||
severity: ValidationIssueSeverity.error, | ||
message: 'Unable to access api.shorebird.dev', | ||
), | ||
], | ||
), | ||
); | ||
}); | ||
}); | ||
}); | ||
}); | ||
} |