Skip to content

Make experiment_options_test less fragile with respect to defaults #1932

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 11, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 47 additions & 32 deletions test/experiment_options_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,62 +7,77 @@ library dartdoc.experiment_options_test;

import 'dart:io';

import 'package:analyzer/src/dart/analysis/experiments.dart';
import 'package:dartdoc/src/dartdoc_options.dart';
import 'package:dartdoc/src/experiment_options.dart';
import 'package:path/path.dart' as pathLib;
import 'package:test/test.dart';

class DartdocExperimentOptionContextTester extends DartdocOptionContext {
DartdocExperimentOptionContextTester(
DartdocOptionSet optionSet, FileSystemEntity entity)
: super(optionSet, entity);
}

void main() {
DartdocOptionSet experimentOptions;
Directory tempDir;
File optionsFile;
Directory emptyTempDir;
ExperimentalFeature defaultOnNotExpired, defaultOffNotExpired;
ExperimentalFeature defaultOnExpired, defaultOffExpired;

setUp(() async {
experimentOptions = await DartdocOptionSet.fromOptionGenerators(
'dartdoc', [createExperimentOptions]);
});

setUpAll(() {
tempDir = Directory.systemTemp.createTempSync('experiment_options_test');
optionsFile = new File(pathLib.join(tempDir.path, 'dartdoc_options.yaml'))
..createSync();
optionsFile.writeAsStringSync('''
dartdoc:
enable-experiment:
- constant-update-2018
- fake-experiment
- no-fake-experiment-on
''');
emptyTempDir =
Directory.systemTemp.createTempSync('experiment_options_test_empty');
// We don't test our functionality at all unless ExperimentStatus has at least
// one of these. TODO(jcollins-g): make analyzer+dartdoc connection
// more amenable to testing.
defaultOnNotExpired = ExperimentStatus.knownFeatures.values.firstWhere(
(f) => f.isEnabledByDefault && !f.isExpired,
orElse: () => null);
defaultOffNotExpired = ExperimentStatus.knownFeatures.values.firstWhere(
(f) => !f.isEnabledByDefault && !f.isExpired,
orElse: () => null);
assert(defaultOnNotExpired != null || defaultOffNotExpired != null,
'No experimental options that are not expired found');

// The "bogus" entries should always exist.
defaultOnExpired = ExperimentStatus.knownFeatures.values
.firstWhere((f) => f.isEnabledByDefault && f.isExpired);
defaultOffExpired = ExperimentStatus.knownFeatures.values
.firstWhere((f) => !f.isEnabledByDefault && f.isExpired);
});

tearDownAll(() {
tempDir.deleteSync(recursive: true);
emptyTempDir.deleteSync(recursive: true);
});

group('Experimental options test', () {
test('Defaults work for all options', () {
experimentOptions.parseArguments([]);
DartdocExperimentOptionContextTester tester =
new DartdocExperimentOptionContextTester(
experimentOptions, Directory.current);
expect(tester.experimentStatus.constant_update_2018, isFalse);
expect(tester.experimentStatus.set_literals, isFalse);
DartdocOptionContext tester =
new DartdocOptionContext(experimentOptions, emptyTempDir);
if (defaultOnNotExpired != null)
expect(tester.experimentStatus.isEnabled(defaultOnNotExpired), isTrue);
if (defaultOffNotExpired != null)
expect(
tester.experimentStatus.isEnabled(defaultOffNotExpired), isFalse);
expect(tester.experimentStatus.isEnabled(defaultOnExpired), isTrue);
expect(tester.experimentStatus.isEnabled(defaultOffExpired), isFalse);
});

test('Overriding defaults works via args', () {
experimentOptions.parseArguments(
['--enable-experiment', 'constant-update-2018,set-literals']);
DartdocExperimentOptionContextTester tester =
new DartdocExperimentOptionContextTester(
experimentOptions, Directory.current);
expect(tester.experimentStatus.constant_update_2018, isTrue);
expect(tester.experimentStatus.set_literals, isTrue);
// Set all arguments to non-default values.
experimentOptions.parseArguments([
'--enable-experiment',
'${defaultOffNotExpired?.disableString},${defaultOnNotExpired?.disableString},${defaultOnExpired.disableString},${defaultOffExpired.enableString}'
]);
DartdocOptionContext tester =
new DartdocOptionContext(experimentOptions, emptyTempDir);
if (defaultOnNotExpired != null)
expect(tester.experimentStatus.isEnabled(defaultOnNotExpired), isFalse);
if (defaultOffNotExpired != null)
expect(
tester.experimentStatus.isEnabled(defaultOffNotExpired), isFalse);
expect(tester.experimentStatus.isEnabled(defaultOnExpired), isTrue);
expect(tester.experimentStatus.isEnabled(defaultOffExpired), isFalse);
});
});
}