Add a conformance test package for http Clients (#706)

Author: brianquinlan

.github/workflows/dart.yml

@@ -0,0 +1,14 @@
+A composable, Future-based library for making HTTP requests.
+
+[![Build Status](https://github.com/dart-lang/http/workflows/Dart%20CI/badge.svg)](https://github.com/dart-lang/http/actions?query=workflow%3A"Dart+CI"+branch%3Amaster)
+
+`package:http` contains a set of high-level functions and classes that make it
+easy to consume HTTP resources. It's multi-platform, and supports mobile, desktop,
+and the browser.
+
+## Packages
+
+| Package | Description | Version |
+|---|---|---|
+| [http](pkgs/http/) | A composable, Future-based library for making HTTP requests. | [![pub package](https://img.shields.io/pub/v/http.svg)](https://pub.dev/packages/http) |
+| [http_client_conformance_tests](pkgs/http_client_conformance_tests/) | Tests for `package:http` `Client` implementations. | [![pub package](https://img.shields.io/pub/v/http_client_conformance_tests.svg)](https://pub.dev/packages/http_client_conformance_tests) |

README.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- Initial version.

README.md

@@ -0,0 +1,27 @@
+Copyright 2014, the Dart project authors. 
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+    * Neither the name of Google LLC nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

pkgs/http_client_conformance_tests/CHANGELOG.md

@@ -0,0 +1,34 @@
+A library that tests whether implementations of `package:http`
+[`Client`'](https://pub.dev/documentation/http/latest/http/Client-class.html)
+behave as expected.
+
+This package is intended to be used in the tests of packages that implement
+`package:http`
+[`Client`'](https://pub.dev/documentation/http/latest/http/Client-class.html).
+
+## Usage
+
+`package:http_client_conformance_tests` is meant to be used in the tests suite
+of a `package:http`
+[`Client`'](https://pub.dev/documentation/http/latest/http/Client-class.html)
+like:
+
+```dart
+import 'package:http/http.dart';
+import 'package:test/test.dart';
+
+import 'package:http_client_conformance_tests/http_client_conformance_tests.dart';
+
+class MyHttpClient extends BaseClient {
+  @override
+  Future<StreamedResponse> send(BaseRequest request) async {
+    // Your implementation here.
+  }
+}
+
+void main() {
+  group('client conformance tests', () {
+    testAll(MyHttpClient());
+  });
+}
+```

pkgs/http_client_conformance_tests/LICENSE

@@ -0,0 +1,17 @@
+import 'package:http/http.dart';
+import 'package:http_client_conformance_tests/http_client_conformance_tests.dart';
+import 'package:test/test.dart';
+
+class MyHttpClient extends BaseClient {
+  @override
+  Future<StreamedResponse> send(BaseRequest request) async {
+    // Your implementation here.
+    throw UnsupportedError('implement this method');
+  }
+}
+
+void main() {
+  group('client conformance tests', () {
+    testAll(MyHttpClient());
+  });
+}

pkgs/http_client_conformance_tests/README.md

@@ -0,0 +1,35 @@
+// Copyright (c) 2022, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:http/http.dart';
+
+import 'src/redirect_tests.dart';
+import 'src/request_body_tests.dart';
+import 'src/request_headers_tests.dart';
+import 'src/response_body_tests.dart';
+import 'src/response_headers_tests.dart';
+
+export 'src/redirect_tests.dart' show testRedirect;
+export 'src/request_body_tests.dart' show testRequestBody;
+export 'src/request_headers_tests.dart' show testRequestHeaders;
+export 'src/response_body_tests.dart' show testResponseBody;
+export 'src/response_headers_tests.dart' show testResponseHeaders;
+
+/// Runs the entire test suite against the given [Client].
+///
+/// If [canStreamRequestBody] is `false` then tests that assume that the
+/// [Client] supports sending HTTP requests with unbounded body sizes will be
+/// skipped.
+//
+/// If [canStreamResponseBody] is `false` then tests that assume that the
+/// [Client] supports receiving HTTP responses with unbounded body sizes will
+/// be skipped
+void testAll(Client client,
+    {bool canStreamRequestBody = true, bool canStreamResponseBody = true}) {
+  testRequestBody(client, canStreamRequestBody: canStreamRequestBody);
+  testResponseBody(client, canStreamResponseBody: canStreamResponseBody);
+  testRequestHeaders(client);
+  testResponseHeaders(client);
+  testRedirect(client);
+}