blob: fd218ee4e18c0a7bae339d93265a862606731710 [file] [log] [blame]
// Copyright 2019 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:cocoon_service/src/request_handling/api_request_handler.dart';
import 'package:cocoon_service/src/request_handling/body.dart';
import 'package:cocoon_service/src/service/logging.dart';
import 'package:gcloud/service_scope.dart' as ss;
import 'package:logging/logging.dart';
import 'package:test/test.dart';
import '../src/datastore/fake_config.dart';
import '../src/request_handling/fake_authentication.dart';
void main() {
group('ApiRequestHandler', () {
late HttpServer server;
late ApiRequestHandler<dynamic> handler;
final List<LogRecord> records = <LogRecord>[];
setUpAll(() async {
server = await HttpServer.bind(InternetAddress.loopbackIPv4, 0);
server.listen((HttpRequest request) {
final ZoneSpecification spec = ZoneSpecification(
print: (Zone self, ZoneDelegate parent, Zone zone, String line) {
log.fine(line);
},
);
runZoned<dynamic>(
() {
return ss.fork(() {
ss.register(#appengine.logging, log);
return handler.service(request);
});
},
zoneSpecification: spec,
);
});
});
tearDownAll(() async {
await server.close();
});
setUp(() {
records.clear();
log.onRecord.listen((LogRecord record) => records.add(record));
});
Future<HttpClientResponse> issueRequest({String? body}) async {
final HttpClient client = HttpClient();
final Uri url = Uri(scheme: 'http', host: 'localhost', port: server.port, path: '/path');
final HttpClientRequest request = await client.getUrl(url);
if (body != null) {
request.contentLength = body.length;
request.write(body);
await request.flush();
}
return request.close();
}
test('failed authentication yields HTTP unauthorized', () async {
handler = Unauth();
final HttpClientResponse response = await issueRequest();
expect(response.statusCode, HttpStatus.unauthorized);
expect(await utf8.decoder.bind(response).join(), 'Not authenticated');
expect(records, isEmpty);
});
test('empty request body yields empty requestData', () async {
handler = ReadParams();
final HttpClientResponse response = await issueRequest();
expect(response.headers.value('X-Test-RequestBody'), '[]');
expect(response.headers.value('X-Test-RequestData'), '{}');
expect(response.statusCode, HttpStatus.ok);
expect(await response.toList(), isEmpty);
expect(records, isEmpty);
});
test('JSON request body yields valid requestData', () async {
handler = ReadParams();
final HttpClientResponse response = await issueRequest(body: '{"param1":"value1"}');
expect(response.headers.value('X-Test-RequestBody'), isNotEmpty);
expect(response.headers.value('X-Test-RequestData'), '{param1: value1}');
expect(response.statusCode, HttpStatus.ok);
expect(await response.toList(), isEmpty);
expect(records, isEmpty);
});
test('non-JSON request body yields HTTP ok', () async {
handler = ReadParams();
final HttpClientResponse response = await issueRequest(body: 'abc');
expect(response.statusCode, HttpStatus.ok);
expect(response.headers.value('X-Test-RequestBody'), '[97, 98, 99]');
expect(response.headers.value('X-Test-RequestData'), '{}');
expect(await response.toList(), isEmpty);
expect(records, isEmpty);
});
test('can access authContext', () async {
handler = AccessAuth();
final HttpClientResponse response = await issueRequest();
expect(response.headers.value('X-Test-IsDev'), 'true');
expect(response.statusCode, HttpStatus.ok);
expect(records, isEmpty);
});
test('missing required request parameters yields HTTP bad request', () async {
handler = NeedsParams();
HttpClientResponse response = await issueRequest();
expect(response.statusCode, HttpStatus.badRequest);
response = await issueRequest(body: '{"param1":"value1"}');
expect(response.statusCode, HttpStatus.badRequest);
response = await issueRequest(body: '{"param2":"value2"}');
expect(response.statusCode, HttpStatus.badRequest);
response = await issueRequest(body: '{"param1":"value1","param2":"value2"}');
expect(response.statusCode, HttpStatus.ok);
response = await issueRequest(body: '{"param1":"value1","param2":"value2","extra":"yes"}');
expect(response.statusCode, HttpStatus.ok);
expect(records, isEmpty);
});
});
}
class Unauth extends ApiRequestHandler<Body> {
Unauth()
: super(
config: FakeConfig(),
authenticationProvider: FakeAuthenticationProvider(authenticated: false),
);
@override
Future<Body> get() async => throw StateError('Unreachable');
}
class Auth extends ApiRequestHandler<Body> {
Auth() : super(config: FakeConfig(), authenticationProvider: FakeAuthenticationProvider());
@override
Future<Body> get() async => Body.empty;
}
class ReadParams extends ApiRequestHandler<Body> {
ReadParams() : super(config: FakeConfig(), authenticationProvider: FakeAuthenticationProvider());
@override
Future<Body> get() async {
response!.headers.add('X-Test-RequestBody', requestBody.toString());
response!.headers.add('X-Test-RequestData', requestData.toString());
return Body.empty;
}
}
class NeedsParams extends ApiRequestHandler<Body> {
NeedsParams() : super(config: FakeConfig(), authenticationProvider: FakeAuthenticationProvider());
@override
Future<Body> get() async {
checkRequiredParameters(<String>['param1', 'param2']);
return Body.empty;
}
}
class AccessAuth extends ApiRequestHandler<Body> {
AccessAuth() : super(config: FakeConfig(), authenticationProvider: FakeAuthenticationProvider());
@override
Future<Body> get() async {
response!.headers.add('X-Test-IsDev', authContext!.clientContext.isDevelopmentEnvironment);
return Body.empty;
}
}