1
0
mirror of https://github.com/flutter/samples.git synced 2025-11-08 13:58:47 +00:00
Files
samples/compass_app/app/test/utils/command_test.dart
Miguel Beltran 57ecb5f7ba refactor Result class, remove asOk and asError (#2542)
As discussed in the PR for the Result pattern implementation
(https://github.com/flutter/website/pull/11444) @parlough recommended
that `asError` and `asOk` should be not be used, and instead we should
use proper exhaustiveness checking.

This PR removes the two "convenience" methods and refactors code.

In some cases, it was enough with writing a proper `if` clause, while in
others it was necessary to use a `switch`.

Still, they are present in the `testing` folder, as they can be useful
for testing purposes.

## Pre-launch Checklist

- [x] I read the [Flutter Style Guide] _recently_, and have followed its
advice.
- [x] I signed the [CLA].
- [x] I read the [Contributors Guide].
- [x] I have added sample code updates to the [changelog].
- [x] I updated/added relevant documentation (doc comments with `///`).

If you need help, consider asking for advice on the #hackers-devrel
channel on [Discord].

<!-- Links -->
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/master/docs/contributing/Style-guide-for-Flutter-repo.md
[CLA]: https://cla.developers.google.com/
[Discord]:
https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md
[Contributors Guide]:
https://github.com/flutter/samples/blob/main/CONTRIBUTING.md
[changelog]: ../CHANGELOG.md
2024-12-05 13:16:04 -05:00

105 lines
2.8 KiB
Dart

// Copyright 2024 The Flutter team. 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:compass_app/utils/command.dart';
import 'package:compass_app/utils/result.dart';
import 'package:flutter_test/flutter_test.dart';
import '../../testing/utils/result.dart';
void main() {
group('Command0 tests', () {
test('should complete void command', () async {
// Void action
final command = Command0<void>(() => Future.value(Result.ok(null)));
// Run void action
await command.execute();
// Action completed
expect(command.completed, true);
});
test('should complete bool command', () async {
// Action that returns bool
final command = Command0<bool>(() => Future.value(Result.ok(true)));
// Run action with result
await command.execute();
// Action completed
expect(command.completed, true);
expect(command.result!.asOk.value, true);
});
test('running should be true', () async {
final command = Command0<void>(() => Future.value(Result.ok(null)));
final future = command.execute();
// Action is running
expect(command.running, true);
// Await execution
await future;
// Action finished running
expect(command.running, false);
});
test('should only run once', () async {
int count = 0;
final command = Command0<int>(() => Future.value(Result.ok(count++)));
final future = command.execute();
// Run multiple times
command.execute();
command.execute();
command.execute();
command.execute();
// Await execution
await future;
// Action is called once
expect(count, 1);
});
test('should handle errors', () async {
final command =
Command0<int>(() => Future.value(Result.error(Exception('ERROR!'))));
await command.execute();
expect(command.error, true);
expect(command.result, isA<Error>());
});
});
group('Command1 tests', () {
test('should complete void command, bool argument', () async {
// Void action with bool argument
final command = Command1<void, bool>((a) {
expect(a, true);
return Future.value(Result.ok(null));
});
// Run void action, ignore void return
await command.execute(true);
expect(command.completed, true);
});
test('should complete bool command, bool argument', () async {
// Action that returns bool argument
final command =
Command1<bool, bool>((a) => Future.value(const Result.ok(true)));
// Run action with result and argument
await command.execute(true);
// Argument was passed to onComplete
expect(command.completed, true);
expect(command.result!.asOk.value, true);
});
});
}