Skip to content
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

feat(shorebird_cli): add forEachRef to Git #1062

Merged
merged 2 commits into from
Aug 8, 2023
Merged
Show file tree
Hide file tree
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
24 changes: 24 additions & 0 deletions packages/shorebird_cli/lib/src/git.dart
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,30 @@ class Git {
}
}

/// Iterate over all refs that match [pattern] and show them
/// according to the given [format].
Future<String> forEachRef({
required String directory,
required String format,
required String pattern,
}) async {
final arguments = ['for-each-ref', '--format', format, pattern];
final result = await process.run(
executable,
arguments,
workingDirectory: directory,
);
if (result.exitCode != 0) {
throw ProcessException(
executable,
arguments,
'${result.stderr}',
result.exitCode,
);
}
return '${result.stdout}'.trim();
}

/// Prunes stale remote branches from the repository at [directory]
/// associated with [name].
Future<void> remotePrune({
Expand Down
53 changes: 53 additions & 0 deletions packages/shorebird_cli/test/src/git_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,59 @@ void main() {
});
});

group('forEachRef', () {
const directory = 'repository';
const format = '%(refname:short)';
const pattern = 'refs/remotes/origin/flutter_release/*';
const output = '''

origin/flutter_release/3.10.0
origin/flutter_release/3.10.1
origin/flutter_release/3.10.2
origin/flutter_release/3.10.3
origin/flutter_release/3.10.4
origin/flutter_release/3.10.5
origin/flutter_release/3.10.6''';
test('executes correct command', () async {
when(() => processResult.stdout).thenReturn(output);
await expectLater(
runWithOverrides(
() => git.forEachRef(
pattern: pattern,
format: format,
directory: directory,
),
),
completion(equals(output.trim())),
);
verify(
() => process.run(
'git',
['for-each-ref', '--format', format, pattern],
workingDirectory: directory,
),
).called(1);
});

test('throws ProcessException if process exits with error', () async {
const error = 'oops';
when(() => processResult.exitCode).thenReturn(ExitCode.software.code);
when(() => processResult.stderr).thenReturn(error);
expect(
() => runWithOverrides(
() => git.forEachRef(
pattern: pattern,
format: format,
directory: directory,
),
),
throwsA(
isA<ProcessException>().having((e) => e.message, 'message', error),
),
);
});
});

group('remotePrune', () {
const directory = './output';
const name = 'origin';
Expand Down