Fix up unit tests & run them in CI (#336)

- remove mockito generated mocks, use nock instead
- lots of test fixes
- add testing matrix
- added a makefile
- added ocktokit scenarios
- actually run tests in CI

Author: robrbecker

.github/workflows/dart.yml

@@ -4,19 +4,16 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     container:
-      image: dart:2.14
-
+      image: dart:2.17
     steps:
     - uses: actions/checkout@v1
     - name: Install dependencies
       run: dart pub get
     - name: Dart Analyzer
       run: dart analyze
     - name: Check Dart Format
-      run: dart format --set-exit-if-changed -o none lib test tool example && echo Dart Format 👍 || echo Files needed Dart formatting 😢
+      run: dart format --set-exit-if-changed -o none lib test tool example integration_test && echo Dart Format 👍 || echo Files needed Dart formatting 😢
     - name: Check if Publishable
       run: dart pub publish --dry-run

.github/workflows/release_unreleased_prs.yml

@@ -12,7 +12,7 @@ jobs:
   release:
     if: github.event.pull_request.merged == true || github.event_name == 'workflow_dispatch'
     runs-on: ubuntu-latest
-    container: dart:2.14.4
+    container: dart:2.17.7
     permissions:
       contents: write
 

.github/workflows/tests.yml

@@ -6,13 +6,19 @@ on:
     branches: [ master ]
 jobs:
   test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        sdk: [2.14.4, 2.17.7, stable] # Test with at least the declared minimum Dart version
     steps:
-    - uses: actions/checkout@v2
-    - uses: dart-lang/setup-dart@v1
-    - name: Install dependencies
-      run: dart pub get
-    # - name: Unit tests
-    #   run: dart test test
-    # - name: Integration tests
-    #   run: dart test integration_test
+      - uses: actions/checkout@v2
+      - uses: dart-lang/[email protected]
+        with:
+          sdk: ${{ matrix.sdk }}
+      - name: Install dependencies
+        run: dart pub get
+      - name: Unit tests
+        run: dart test
+      # - name: Integration tests
+      #   run: dart test integration_test

Makefile

@@ -0,0 +1,20 @@
+.DEFAULT_GOAL := help
+SHELL=/bin/bash -o pipefail
+
+# Cite: https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+.PHONY: help
+help: ## Display this help page
+	@grep -E '^[a-zA-Z0-9/_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: fixtures
+fixtures: ## Run octokit-fixtures-server for scenario tests
+	@npx octokit-fixtures-server &
+
+.PHONY: stop
+stop: ## Stop the fixtures server
+	@killall node
+
+.PHONY: test
+test: fixtures ## Run tests
+	@dart test -P all
+	make stop

dart_test.yaml

@@ -0,0 +1,15 @@
+tags:
+  scenarios:
+    skip: |
+      Not run by default when running dart test. To run:
+        npx octokit-fixtures-server
+        dart test -P scenarios
+      or run all tests with:
+        make test
+    
+presets:
+  scenarios:
+    include_tags: scenarios
+    run_skipped: true
+  all:
+    run_skipped: true

lib/src/common/model/misc.dart

@@ -44,10 +44,14 @@ class RateLimit {
   ///
   /// API docs: https://developer.github.com/v3/rate_limit/
   factory RateLimit.fromRateLimitResponse(Map<String, dynamic> response) {
-    final rateJson = response['rate'] as Map<String, dynamic>;
-    final limit = rateJson['limit'] as int?;
-    final remaining = rateJson['remaining'] as int?;
-    final resets = DateTime.fromMillisecondsSinceEpoch(rateJson['reset']!);
+    final rateJson = response['rate'] == null
+        ? null
+        : response['rate'] as Map<String, dynamic>;
+    final limit = rateJson?['limit'] as int?;
+    final remaining = rateJson?['remaining'] as int?;
+    final resets = rateJson?['reset'] == null
+        ? null
+        : DateTime.fromMillisecondsSinceEpoch(rateJson?['reset']);
     return RateLimit(limit, remaining, resets);
   }
 

lib/src/common/model/repos_releases.dart

@@ -175,6 +175,7 @@ class CreateRelease {
 
   String? discussionCategoryName;
 
+  @JsonKey(defaultValue: false)
   bool generateReleaseNotes = false;
 
   CreateRelease(this.tagName);

lib/src/common/model/repos_releases.g.dart

@@ -21,7 +21,8 @@ dev_dependencies:
   json_serializable: ^6.0.0
   lints: ^1.0.0
   mockito: ^5.0.0
-  pub_semver: 
+  nock: ^1.0.0
+  pub_semver: ^2.0.0
   test: ^1.16.0
   yaml: ^3.0.0
   yaml_edit: