feat(cli)!: refactor factory/CLI to be more testable #725
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| // Copyright 2019 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| // Factory shared by GitHub Action and CLI for creating Release PRs | ||
| // and GitHub Releases: | ||
|
|
||
| import {ReleasePR, ReleasePROptions} from './release-pr'; | ||
| import {RubyReleasePROptions} from './releasers/ruby'; | ||
| import { | ||
| GitHubReleaseOptions, | ||
| GitHubRelease, | ||
| ReleaseResponse, | ||
| } from './github-release'; | ||
| import {getReleasers} from './releasers'; | ||
|
|
||
| function runCommand( | ||
| command: string, | ||
| options: GitHubReleaseOptions | ReleasePROptions | ||
| ): Promise<number | undefined | ReleaseResponse> { | ||
| if (isGitHubRelease(command, options)) { | ||
| return factory.run(githubRelease(options)); | ||
| } else { | ||
| return factory.run(releasePR(options)); | ||
| } | ||
| } | ||
|
|
||
| function isGitHubRelease( | ||
| command: string, | ||
| options: GitHubReleaseOptions | ReleasePROptions | ||
| ): options is GitHubReleaseOptions { | ||
| return command === 'github-release' && typeof options === 'object'; | ||
| } | ||
|
|
||
| function run(runnable: ReleasePR | GitHubRelease) { | ||
| return runnable.run(); | ||
| } | ||
|
|
||
| function githubRelease(options: GitHubReleaseOptions): GitHubRelease { | ||
| return new GitHubRelease(options); | ||
| } | ||
|
|
||
| function releasePR(options: ReleasePROptions): ReleasePR { | ||
| const releaseOptions: ReleasePROptions | RubyReleasePROptions = options; | ||
| return new (factory.releasePRClass(options.releaseType))(releaseOptions); | ||
| } | ||
|
|
||
| export function releasePRClass(releaseType: string): typeof ReleasePR { | ||
bcoe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const releasers = getReleasers(); | ||
| const releaser = releasers[releaseType]; | ||
| if (!releaser) { | ||
| throw Error('unknown release type'); | ||
| } | ||
| return releaser; | ||
| } | ||
|
|
||
| export const factory = { | ||
| githubRelease, | ||
| releasePR, | ||
| releasePRClass, | ||
| run, | ||
| runCommand, | ||
| }; | ||
|
Comment on lines
+67
to
+73
Contributor
There was a problem hiding this comment. I like this common factory. nifty how you collected them together like this for a single entry point.
Author
There was a problem hiding this comment. It's maybe note the most "TypeScripty" looking code, but it's an approach I learned from working on Node: https://github.com/nodejs/node/blob/master/lib/fs.js#L2058 I've found it makes it really easy to mock the methods, vs., static methods. |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.