test(examples): add kitchen_sink example w/e2e tests

Author: felangel

.github/workflows/examples_kitchen_sink.yaml

@@ -0,0 +1,34 @@
+name: examples/kitchen_sink
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    paths:
+      - "examples/kitchen_sink/routes/**"
+      - "examples/kitchen_sink/lib/**"
+      - "examples/kitchen_sink/test/**"
+      - "examples/kitchen_sink/e2e/**"
+      - ".github/workflows/examples_kitchen_sink.yaml"
+      - "packages/dart_frog/lib/**"
+      - "packages/dart_frog/pubspec.yaml"
+      - "packages/dart_frog_cli/lib/**"
+      - "packages/dart_frog_cli/pubspec.yaml"
+    branches:
+      - main
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
+    with:
+      working_directory: examples/kitchen_sink
+      analyze_directories: "routes test"
+      report_on: "routes"
+
+  docker:
+    uses: ./.github/workflows/.docker_tests.yaml
+    with:
+      setup: rm pubspec_overrides.yaml && dart pub global activate --source path ../../packages/dart_frog_cli
+      working_directory: examples/kitchen_sink

examples/kitchen_sink/.gitignore

@@ -0,0 +1,13 @@
+# See https://www.dartlang.org/guides/libraries/private-files
+
+# Files and directories created by pub
+.dart_tool/
+.packages
+pubspec.lock
+
+# Files and directories created by dart_frog
+build/
+.dart_frog
+
+# Test related files
+coverage/

examples/kitchen_sink/README.md

@@ -0,0 +1,12 @@
+# Kitchen Sink
+
+[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
+[![License: MIT][license_badge]][license_link]
+[![Powered by Dart Frog](https://img.shields.io/endpoint?url=https://tinyurl.com/dartfrog-badge)](https://dartfrog.vgv.dev)
+
+A kitchen sink example app built with `dart_frog`.
+
+[license_badge]: https://img.shields.io/badge/license-MIT-blue.svg
+[license_link]: https://opensource.org/licenses/MIT
+[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
+[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis

examples/kitchen_sink/analysis_options.yaml

@@ -0,0 +1,7 @@
+include: package:very_good_analysis/analysis_options.3.1.0.yaml
+analyzer:
+  exclude:
+    - build/**
+linter:
+  rules:
+    file_names: false

examples/kitchen_sink/e2e/index_test.dart

@@ -0,0 +1,79 @@
+import 'dart:io';
+
+import 'package:http/http.dart' as http;
+import 'package:test/test.dart';
+
+void main() {
+  group('E2E', () {
+    const greeting = 'Hello';
+    test('GET / responds with "Hello"', () async {
+      final response = await http.get(Uri.parse('http://localhost:8080'));
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals(greeting));
+    });
+
+    test('GET /favicon.ico responds with the favicon.ico', () async {
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/favicon.ico'),
+      );
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, isNotEmpty);
+    });
+
+    test('GET /greet/<name> responds with the "Hello <name>"', () async {
+      const name = 'Frog';
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/greet/$name'),
+      );
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals('Hello $name'));
+    });
+
+    test('GET /users/<id> responds with the "Hello user <id>"', () async {
+      const id = 'id';
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/users/$id'),
+      );
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals('$greeting user $id'));
+    });
+
+    test('GET /users/<id>/<name> responds with the "Hello <name> (user <id>)"',
+        () async {
+      const id = 'id';
+      const name = 'Frog';
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/users/$id/$name'),
+      );
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals('$greeting $name (user $id)'));
+    });
+
+    test('GET /api/pets responds with unauthorized when header is missing',
+        () async {
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/api/pets'),
+      );
+      expect(response.statusCode, equals(HttpStatus.unauthorized));
+    });
+
+    test('GET /api/pets responds with "Hello pets"', () async {
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/api/pets'),
+        headers: {HttpHeaders.authorizationHeader: 'token'},
+      );
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals('$greeting pets'));
+    });
+
+    test('GET /api/pets/<name> responds with "Hello <name>"', () async {
+      const name = 'Frog';
+      final response = await http.get(
+        Uri.parse('http://localhost:8080/api/pets/$name'),
+        headers: {HttpHeaders.authorizationHeader: 'token'},
+      );
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals('$greeting $name'));
+    });
+  });
+}

examples/kitchen_sink/public/favicon.ico

@@ -0,0 +1,16 @@
+name: kitchen_sink
+description: A kitchen sink example with Dart Frog.
+version: 1.0.0+1
+publish_to: none
+
+environment:
+  sdk: ">=2.18.0 <3.0.0"
+
+dependencies:
+  dart_frog: ^0.2.0
+
+dev_dependencies:
+  http: ^0.13.5
+  mocktail: ^0.3.0
+  test: ^1.19.2
+  very_good_analysis: ^3.1.0

examples/kitchen_sink/pubspec.yaml

@@ -0,0 +1,3 @@
+dependency_overrides:
+  dart_frog:
+    path: ../../packages/dart_frog

examples/kitchen_sink/pubspec_overrides.yaml

@@ -0,0 +1,7 @@
+import 'package:dart_frog/dart_frog.dart';
+
+const _greeting = 'Hello';
+
+Handler middleware(Handler handler) {
+  return handler.use(provider<String>((_) => _greeting));
+}

examples/kitchen_sink/routes/_middleware.dart

@@ -0,0 +1,12 @@
+import 'dart:io';
+
+import 'package:dart_frog/dart_frog.dart';
+
+Handler middleware(Handler handler) {
+  return (context) {
+    if (!context.request.headers.containsKey(HttpHeaders.authorizationHeader)) {
+      return Response(statusCode: HttpStatus.unauthorized);
+    }
+    return handler(context);
+  };
+}