test(dart_frog_cli): add e2e tests (#71)

Author: felangel

.github/workflows/dart_frog_cli.yaml

@@ -4,6 +4,7 @@ on:
   pull_request:
     paths:
       - ".github/workflows/dart_frog_cli.yaml"
+      - "packages/dart_frog_cli/e2e/**"
       - "packages/dart_frog_cli/lib/**"
       - "packages/dart_frog_cli/test/**"
       - "packages/dart_frog_cli/pubspec.yaml"
@@ -12,6 +13,7 @@ on:
       - main
     paths:
       - ".github/workflows/dart_frog_cli.yaml"
+      - "packages/dart_frog_cli/e2e/**"
       - "packages/dart_frog_cli/lib/**"
       - "packages/dart_frog_cli/test/**"
       - "packages/dart_frog_cli/pubspec.yaml"
@@ -22,6 +24,28 @@ jobs:
     with:
       working_directory: packages/dart_frog_cli
 
+  e2e:
+    defaults:
+      run:
+        working-directory: packages/dart_frog_cli/e2e
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v2
+
+      - name: 🎯 Setup Dart
+        uses: dart-lang/setup-dart@v1
+
+      - name: 📦 Install Dependencies
+        run: |
+          dart pub global activate --source path ../
+          dart pub get
+
+      - name: 🧪 Run E2E Tests
+        run: dart test -j 1
+
   pana:
     defaults:
       run:
@@ -30,12 +54,16 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/[email protected]
-      - uses: dart-lang/setup-dart@v1
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v2
+
+      - name: 🎯 Setup Dart
+        uses: dart-lang/setup-dart@v1
 
-      - name: Install Dependencies
+      - name: 📦 Install Dependencies
         run: |
           dart pub get
           dart pub global activate pana
-      - name: Verify Pub Score
+
+      - name: 📊 Verify Pub Score
         run: ../../tool/verify_pub_score.sh

packages/dart_frog_cli/e2e/pubspec.yaml

@@ -0,0 +1,13 @@
+name: dart_frog_cli_e2e
+description: End to End tests for package:dart_frog_cli
+publish_to: none
+
+environment:
+  sdk: ">=2.17.0 <3.0.0"
+
+dev_dependencies:
+  http: ^0.13.4
+  meta: ^1.7.0
+  path: ^1.8.2
+  test: ^1.19.2
+  very_good_analysis: ^3.0.0

packages/dart_frog_cli/e2e/test/dev_smoke_test.dart

@@ -0,0 +1,48 @@
+import 'dart:io';
+
+import 'package:http/http.dart' as http;
+import 'package:path/path.dart' as path;
+import 'package:test/test.dart';
+
+import 'helpers/helpers.dart';
+
+/// Objectives:
+///
+/// * Generate a new Dart Frog project via `dart_frog create`
+/// * Run the dev server via `dart_frog dev`
+/// * Ensure the server responds accordingly for built-in endpoints
+void main() {
+  group('Dev Server Smoke Test', () {
+    const projectName = 'example';
+    final tempDirectory = Directory.systemTemp.createTempSync();
+
+    setUpAll(() async {
+      await dartFrogCreate(projectName: projectName, directory: tempDirectory);
+      await dartFrogDev(
+        directory: Directory(path.join(tempDirectory.path, projectName)),
+      );
+    });
+
+    tearDownAll(() async {
+      await killDartFrogServer();
+      await tempDirectory.delete(recursive: true);
+    });
+
+    testServer('GET / returns 200 with greeting', (host) async {
+      final response = await http.get(Uri.parse(host));
+      expect(response.statusCode, equals(HttpStatus.ok));
+      expect(response.body, equals('Welcome to Dart Frog!'));
+      expect(response.headers, contains('date'));
+      expect(
+        response.headers,
+        containsPair('content-type', 'text/plain; charset=utf-8'),
+      );
+    });
+
+    testServer('GET /not_here returns 404', (host) async {
+      final response = await http.get(Uri.parse('$host/not_here'));
+      expect(response.statusCode, HttpStatus.notFound);
+      expect(response.body, 'Route not found');
+    });
+  });
+}

packages/dart_frog_cli/e2e/test/helpers/dart_frog_create.dart

@@ -0,0 +1,15 @@
+import 'dart:io';
+
+Future<void> dartFrogCreate({
+  required String projectName,
+  required Directory directory,
+}) async {
+  final result = await Process.run(
+    'dart_frog',
+    ['create', projectName],
+    workingDirectory: directory.path,
+  );
+  if (result.exitCode != 0) {
+    throw Exception('dart_frog create exited with code $exitCode');
+  }
+}

packages/dart_frog_cli/e2e/test/helpers/dart_frog_dev.dart

@@ -0,0 +1,35 @@
+import 'dart:async';
+import 'dart:convert';
+import 'dart:io';
+
+Future<void> dartFrogDev({required Directory directory}) async {
+  final completer = Completer<void>();
+
+  final process = await Process.start(
+    'dart_frog',
+    ['dev'],
+    workingDirectory: directory.path,
+  );
+
+  late StreamSubscription stdoutSubscription;
+  late StreamSubscription stderrSubscription;
+
+  stdoutSubscription = process.stdout.listen((event) {
+    final message = utf8.decode(event);
+    if (message.contains('Hot reload is enabled.')) {
+      stdoutSubscription.cancel();
+      stderrSubscription.cancel();
+      completer.complete();
+    }
+  });
+
+  stderrSubscription = process.stderr.listen((event) {
+    final message = utf8.decode(event);
+    stdoutSubscription.cancel();
+    stderrSubscription.cancel();
+    completer.completeError(message);
+    exit(1);
+  });
+
+  await completer.future;
+}

packages/dart_frog_cli/e2e/test/helpers/helpers.dart

@@ -0,0 +1,4 @@
+export 'dart_frog_create.dart';
+export 'dart_frog_dev.dart';
+export 'kill_dart_frog_server.dart';
+export 'test_server.dart';

packages/dart_frog_cli/e2e/test/helpers/kill_dart_frog_server.dart

@@ -0,0 +1,8 @@
+import 'dart:io';
+
+Future<void> killDartFrogServer() async {
+  final result = await Process.run('pkill', ['-f', 'dart_frog']);
+  if (result.exitCode != 0) {
+    throw Exception('pkill -f dart_frog exited with code $exitCode');
+  }
+}

packages/dart_frog_cli/e2e/test/helpers/test_server.dart

@@ -0,0 +1,13 @@
+import 'package:meta/meta.dart';
+import 'package:test/test.dart';
+
+@isTest
+void testServer(String name, Future<void> Function(String host) func) {
+  test(
+    name,
+    () async => func('http://localhost:8080'),
+    timeout: _defaultTimeout,
+  );
+}
+
+const _defaultTimeout = Timeout(Duration(seconds: 3));