Session/9

.vscode/settings.json

@@ -5,5 +5,9 @@
   },
   "files.watcherExclude": {
     "**/.fvm": true
+  },
+  "explorer.fileNesting.enabled": true,
+  "explorer.fileNesting.patterns": {
+    "*.dart": "$(capture).g.dart, $(capture).freezed.dart"
   }
 }

pubspec.lock

@@ -459,6 +459,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.4"
+  mockito:
+    dependency: "direct main"
+    description:
+      name: mockito
+      sha256: "7d5b53bcd556c1bc7ffbe4e4d5a19c3e112b7e925e9e172dd7c6ad0630812616"
+      url: "https://pub.dev"
+    source: hosted
+    version: "5.4.2"
   package_config:
     dependency: transitive
     description:

pubspec.yaml

@@ -15,6 +15,7 @@ dependencies:
 
   freezed_annotation: ^2.4.1
   json_annotation: ^4.8.1
+  mockito: ^5.4.2
   riverpod_annotation: ^2.1.5
   yumemi_weather:
     git:

test/model/weather_forecast_test.dart

@@ -0,0 +1,107 @@
+import 'dart:convert';
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:flutter_training/model/weather_condition.dart';
+import 'package:flutter_training/model/weather_forecast.dart';
+import 'package:freezed_annotation/freezed_annotation.dart';
+
+void main() {
+  test('success case: fromJson', () {
+    const jsonData = '''
+        {
+          "weather_condition": "cloudy",
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+    final data = jsonDecode(jsonData) as Map<String, dynamic>;
+    final result = WeatherForecast.fromJson(data);
+
+    expect(
+      result,
+      WeatherForecast(
+        weatherCondition: WeatherCondition.cloudy,
+        maxTemperature: 25,
+        minTemperature: 7,
+        date: DateTime(2023, 9, 19, 10, 24, 31, 877),
+      ),
+    );
+  });
+
+  group('fromJson failure: CheckedFromJsonException should be thrown.', () {
+    test('non-exist weather', () {
+      const jsonData = '''
+        {
+          "weather_condition": "thunder",
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+      final data = jsonDecode(jsonData) as Map<String, dynamic>;
+
+      expect(
+        () => WeatherForecast.fromJson(data),
+        throwsA(isA<CheckedFromJsonException>()),
+        reason: 'thunder does not exist in WeatherCondition',
+      );
+    });
+
+    test('jsonData has wrong key', () {
+      const jsonData = '''
+        {
+          "weather_condition_wrong_key": "cloudy",
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+      final data = jsonDecode(jsonData) as Map<String, dynamic>;
+
+      expect(
+        () => WeatherForecast.fromJson(data),
+        throwsA(isA<CheckedFromJsonException>()),
+      );
+    });
+
+    test('unexpected type of value', () {
+      const jsonData = '''
+        {
+          "weather_condition": 42.195,
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+      final data = jsonDecode(jsonData) as Map<String, dynamic>;
+
+      expect(
+        () => WeatherForecast.fromJson(data),
+        throwsA(isA<CheckedFromJsonException>()),
+        reason: 'weather_condition expect <WeatherCondition>',
+      );
+    });
+
+    test('required property is missing', () {
+      const jsonData = '''
+        {
+          "weather_condition": "cloudy",
+          "max_temperature": 25, 
+          "date": "2023-09-19 10:24:31.877"
+        }
+        ''';
+
+      final data = jsonDecode(jsonData) as Map<String, dynamic>;
+
+      expect(
+        () => WeatherForecast.fromJson(data),
+        throwsA(isA<CheckedFromJsonException>()),
+        reason: 'min_temperature is required',
+      );
+    });
+  });
+}

test/model/weather_reqest_test.dart

@@ -0,0 +1,20 @@
+import 'dart:convert';
+
+import 'package:flutter_test/flutter_test.dart';
+import 'package:flutter_training/model/weather_request.dart';
+
+void main() {
+  test('success case: encode WeatherRequest', () {
+    final request = WeatherRequest(
+      area: 'Nagoya',
+      date: DateTime(2023, 9, 19),
+    );
+
+    final requestJson = jsonEncode(request);
+
+    expect(
+      requestJson,
+      '{"area":"Nagoya","date":"2023-09-19T00:00:00.000"}',
+    );
+  });
+}

test/service/weather_service_test.dart

@@ -0,0 +1,98 @@
+import 'package:flutter_riverpod/flutter_riverpod.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:flutter_training/model/weather_condition.dart';
+import 'package:flutter_training/model/weather_forecast.dart';
+import 'package:flutter_training/model/weather_request.dart';
+import 'package:flutter_training/service/weather_service.dart';
+import 'package:flutter_training/utils/api/result.dart';
+import 'package:mockito/annotations.dart';
+import 'package:mockito/mockito.dart';
+import 'package:yumemi_weather/yumemi_weather.dart';
+
+import 'weather_service_test.mocks.dart';
+
+const jsonData = '''
+        {
+          "weather_condition": "cloudy",
+          "max_temperature": 25, 
+          "min_temperature": 7,
+          "date": "2023-09-19T00:00:00.000"
+        }
+        ''';
+
+final request = WeatherRequest(
+  area: 'Nagoya',
+  date: DateTime(2023, 9, 19),
+);
+
+@GenerateNiceMocks([MockSpec<YumemiWeather>()])
+void main() {
+  final mockClient = MockYumemiWeather();
+  late ProviderContainer container;
+
+  setUp(() {
+    //mockのYumemiWeatherでDIする
+    container = ProviderContainer(
+      overrides: [yumemiWeatherClientProvider.overrideWithValue(mockClient)],
+    );
+  });
+
+  tearDown(() {
+    container.dispose();
+  });
+
+  test('success case', () {
+    when(mockClient.fetchWeather(any)).thenReturn(jsonData);
+
+    final result = container.read(weatherServiceProvider).fetchWeather(request);
+
+    expect(
+      result,
+      isA<Success<WeatherForecast, String>>().having(
+        (success) => success.value,
+        'success weather data',
+        WeatherForecast(
+          weatherCondition: WeatherCondition.cloudy,
+          maxTemperature: 25,
+          minTemperature: 7,
+          date: DateTime(2023, 9, 19),
+        ),
+      ),
+    );
+  });
+
+  group('failure case', () {
+    test('invalidParameter error is thrown', () {
+      when(mockClient.fetchWeather(any))
+          .thenThrow(YumemiWeatherError.invalidParameter);
+
+      final result =
+          container.read(weatherServiceProvider).fetchWeather(request);
+
+      expect(
+        result,
+        isA<Failure<WeatherForecast, String>>().having(
+          (error) => error.exception,
+          'error message',
+          'パラメータが有効ではありません。',
+        ),
+      );
+    });
+
+    test('unknown error is thrown', () {
+      when(mockClient.fetchWeather(any)).thenThrow(YumemiWeatherError.unknown);
+
+      final result =
+          container.read(weatherServiceProvider).fetchWeather(request);
+
+      expect(
+        result,
+        isA<Failure<WeatherForecast, String>>().having(
+          (error) => error.exception,
+          'error message',
+          '予期せぬエラーが発生しました。',
+        ),
+      );
+    });
+  });
+}

test/service/weather_service_test.mocks.dart

@@ -0,0 +1,63 @@
+// Mocks generated by Mockito 5.4.2 from annotations
+// in flutter_training/test/service/weather_service_test.dart.
+// Do not manually edit this file.
+
+// ignore_for_file: no_leading_underscores_for_library_prefixes
+import 'package:mockito/mockito.dart' as _i1;
+import 'package:yumemi_weather/src/yumemi_weather_base.dart' as _i2;
+
+// ignore_for_file: type=lint
+// ignore_for_file: avoid_redundant_argument_values
+// ignore_for_file: avoid_setters_without_getters
+// ignore_for_file: comment_references
+// ignore_for_file: implementation_imports
+// ignore_for_file: invalid_use_of_visible_for_testing_member
+// ignore_for_file: prefer_const_constructors
+// ignore_for_file: unnecessary_parenthesis
+// ignore_for_file: camel_case_types
+// ignore_for_file: subtype_of_sealed_class
+
+/// A class which mocks [YumemiWeather].
+///
+/// See the documentation for Mockito's code generation for more information.
+class MockYumemiWeather extends _i1.Mock implements _i2.YumemiWeather {
+  @override
+  String fetchSimpleWeather() => (super.noSuchMethod(
+        Invocation.method(
+          #fetchSimpleWeather,
+          [],
+        ),
+        returnValue: '',
+        returnValueForMissingStub: '',
+      ) as String);
+
+  @override
+  String fetchThrowsWeather(String? area) => (super.noSuchMethod(
+        Invocation.method(
+          #fetchThrowsWeather,
+          [area],
+        ),
+        returnValue: '',
+        returnValueForMissingStub: '',
+      ) as String);
+
+  @override
+  String fetchWeather(String? jsonString) => (super.noSuchMethod(
+        Invocation.method(
+          #fetchWeather,
+          [jsonString],
+        ),
+        returnValue: '',
+        returnValueForMissingStub: '',
+      ) as String);
+
+  @override
+  String syncFetchWeather(String? jsonString) => (super.noSuchMethod(
+        Invocation.method(
+          #syncFetchWeather,
+          [jsonString],
+        ),
+        returnValue: '',
+        returnValueForMissingStub: '',
+      ) as String);
+}