-
Notifications
You must be signed in to change notification settings - Fork 25
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
Add functions to make certain assertions #18
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains 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,27 @@ | ||
package entrypoint | ||
|
||
import ( | ||
"fmt" | ||
"github.com/urfave/cli" | ||
"os" | ||
) | ||
|
||
// StringFlagRequiredE checks if a required string flag is passed in on the CLI. This will return the set string, or an | ||
// error if the flag is not passed in. | ||
func StringFlagRequiredE(cliContext *cli.Context, flagName string) (string, error) { | ||
value := cliContext.String(flagName) | ||
if value == "" { | ||
return "", fmt.Errorf("--%s is required", flagName) | ||
} | ||
return value, nil | ||
} | ||
|
||
// EnvironmentVarRequiredE checks if a required environment variable is set. This will return the environment variable | ||
// value, or an error if the environment variable is not set. | ||
func EnvironmentVarRequiredE(varName string) (string, error) { | ||
value := os.Getenv(varName) | ||
if value == "" { | ||
return "", fmt.Errorf("The environment variable %s is required to be set", varName) | ||
} | ||
return value, nil | ||
} |
This file contains 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,60 @@ | ||
package entrypoint | ||
|
||
import ( | ||
"os" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
"github.com/urfave/cli" | ||
) | ||
|
||
func TestStringFlagRequiredOnMissingFlag(t *testing.T) { | ||
t.Parallel() | ||
|
||
app := createSampleAppWithRequiredFlag() | ||
app.Action = func(cliContext *cli.Context) error { | ||
value, err := StringFlagRequiredE(cliContext, "the-answer-to-all-problems") | ||
assert.NotNil(t, err) | ||
assert.Equal(t, value, "") | ||
return nil | ||
} | ||
args := []string{"app"} | ||
app.Run(args) | ||
} | ||
|
||
func TestStringFlagRequiredOnSetFlag(t *testing.T) { | ||
t.Parallel() | ||
|
||
app := createSampleAppWithRequiredFlag() | ||
app.Action = func(cliContext *cli.Context) error { | ||
value, err := StringFlagRequiredE(cliContext, "the-answer-to-all-problems") | ||
assert.Nil(t, err) | ||
assert.Equal(t, value, "42") | ||
return nil | ||
} | ||
args := []string{"app", "--the-answer-to-all-problems", "42"} | ||
app.Run(args) | ||
} | ||
|
||
func TestEnvironmentVarRequiredOnMissingEnvVar(t *testing.T) { | ||
value, err := EnvironmentVarRequiredE("THE_ANSWER_TO_ALL_PROBLEMS") | ||
assert.NotNil(t, err) | ||
assert.Equal(t, value, "") | ||
} | ||
|
||
func TestEnvironmentVarRequiredOnSetEnvVar(t *testing.T) { | ||
os.Setenv("THE_ANSWER_TO_ALL_PROBLEMS", "42") | ||
value, err := EnvironmentVarRequiredE("THE_ANSWER_TO_ALL_PROBLEMS") | ||
assert.Nil(t, err) | ||
assert.Equal(t, value, "42") | ||
} | ||
|
||
func createSampleAppWithRequiredFlag() *cli.App { | ||
app := cli.NewApp() | ||
app.Flags = []cli.Flag{ | ||
cli.StringFlag{ | ||
Name: "the-answer-to-all-problems", | ||
}, | ||
} | ||
return app | ||
} |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Create a custom type of errors. It makes it easier to check for errors and write tests against them.