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.

Sign up for GitHub

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

Jump to bottom

Remove env vars #112

Merged
merged 12 commits into from Feb 23, 2022
Merged

Remove env vars #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
7e6de1d
test action
rohankh532 Feb 11, 2022
1765329
Merge pull request #1 from rohankh532/scorecard-cosign-api
rohankh532 Feb 11, 2022
a6a828c
Merge branch 'ossf:main' into main
rohankh532 Feb 18, 2022
c336f33
Merge branch 'main' of https://github.com/ossf/scorecard-action
rohankh532 Feb 23, 2022
a8d9209
removed SCORECARD_POLICY_FILE env var
rohankh532 Feb 23, 2022
abb3517
removed SCORECARD_BIN env var
rohankh532 Feb 23, 2022
0b8f1d3
removed ENABLED_CHECKS env var
rohankh532 Feb 23, 2022
6efb14a
removed SCORECARD_PRIVATE_REPOSITORY env var
rohankh532 Feb 23, 2022
6ad106a
removed SCORECARD_DEFAULT_BRANCH env var
rohankh532 Feb 23, 2022
22e8f09
removed SCORECARD_PUBLISH_RESULTS env var
rohankh532 Feb 23, 2022
e9d8e9f
removed SCORECARD_RESULTS_FORMAT env var
rohankh532 Feb 23, 2022
d103d8d
removed SCORECARD_RESULTS_FILE env var
rohankh532 Feb 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions action.yaml
View file
Open in desktop
Expand Up @@ -44,3 +44,4 @@ runs:
using: "docker"
image: "./Dockerfile"


81 changes: 28 additions & 53 deletions main.go
View file
Open in desktop
Expand Up @@ -41,6 +41,12 @@ var (
errEmptyGitHubAuthToken = errors.New("repo_token variable is empty")
errOnlyDefaultBranchSupported = errors.New("only default branch is supported")
errEmptyScorecardBin = errors.New("scorecard_bin variable is empty")
enabledChecks = ""
scorecardPrivateRepository = ""
scorecardDefaultBranch = ""
scorecardPublishResults = ""
scorecardResultsFormat = ""
scorecardResultsFile = ""
)

type repositoryInformation struct {
Expand All @@ -52,26 +58,20 @@ const (
enableSarif = "ENABLE_SARIF"
enableLicense = "ENABLE_LICENSE"
enableDangerousWorkflow = "ENABLE_DANGEROUS_WORKFLOW"
enabledChecks = "ENABLED_CHECKS"
githubEventPath = "GITHUB_EVENT_PATH"
githubEventName = "GITHUB_EVENT_NAME"
githubRepository = "GITHUB_REPOSITORY"
githubRef = "GITHUB_REF"
githubWorkspace = "GITHUB_WORKSPACE"
//nolint:gosec
githubAuthToken = "GITHUB_AUTH_TOKEN"
inputresultsfile = "INPUT_RESULTS_FILE"
inputresultsformat = "INPUT_RESULTS_FORMAT"
inputpublishresults = "INPUT_PUBLISH_RESULTS"
scorecardBin = "SCORECARD_BIN"
scorecardResultsFormat = "SCORECARD_RESULTS_FORMAT"
scorecardPublishResults = "SCORECARD_PUBLISH_RESULTS"
scorecardPolicyFile = "SCORECARD_POLICY_FILE"
scorecardResultsFile = "SCORECARD_RESULTS_FILE"
scorecardFork = "SCORECARD_IS_FORK"
scorecardDefaultBranch = "SCORECARD_DEFAULT_BRANCH"
scorecardPrivateRepository = "SCORECARD_PRIVATE_REPOSITORY"
sarif = "sarif"
githubAuthToken = "GITHUB_AUTH_TOKEN"
inputresultsfile = "INPUT_RESULTS_FILE"
inputresultsformat = "INPUT_RESULTS_FORMAT"
inputpublishresults = "INPUT_PUBLISH_RESULTS"
scorecardBin = "/scorecard"
scorecardPolicyFile = "./policy.yml"
scorecardFork = "SCORECARD_IS_FORK"
sarif = "sarif"
)

// main is the entrypoint for the action.
Expand Down Expand Up @@ -109,8 +109,8 @@ func main() {

// gets the cmd run settings
cmd, err := runScorecardSettings(os.Getenv(githubEventName),
os.Getenv(scorecardPolicyFile), os.Getenv(scorecardResultsFormat),
os.Getenv(scorecardBin), os.Getenv(scorecardResultsFile), os.Getenv(githubRepository))
scorecardPolicyFile, scorecardResultsFormat,
scorecardBin, scorecardResultsFile, os.Getenv(githubRepository))
if err != nil {
panic(err)
}
Expand All @@ -119,7 +119,7 @@ func main() {
panic(err)
}

results, err := ioutil.ReadFile(os.Getenv(scorecardResultsFile))
results, err := ioutil.ReadFile(scorecardResultsFile)
if err != nil {
panic(err)
}
Expand All @@ -143,9 +143,6 @@ func initalizeENVVariables() error {
envvars[enableSarif] = "1"
envvars[enableLicense] = "1"
envvars[enableDangerousWorkflow] = "1"
envvars[scorecardPolicyFile] = "./policy.yml"
envvars[scorecardBin] = "/scorecard"
envvars[enabledChecks] = ""

for key, val := range envvars {
if err := os.Setenv(key, val); err != nil {
Expand All @@ -159,9 +156,7 @@ func initalizeENVVariables() error {
if result == "" {
return errInputResultFileEmpty
}
if err := os.Setenv(scorecardResultsFile, result); err != nil {
return fmt.Errorf("error setting %s: %w", scorecardResultsFile, err)
}
scorecardResultsFile = result
}

if result, exists := os.LookupEnv(inputresultsformat); !exists {
Expand All @@ -170,9 +165,7 @@ func initalizeENVVariables() error {
if result == "" {
return errInputResultFormatEmtpy
}
if err := os.Setenv(scorecardResultsFormat, result); err != nil {
return fmt.Errorf("error setting %s: %w", scorecardResultsFormat, err)
}
scorecardResultsFormat = result
}

if result, exists := os.LookupEnv(inputpublishresults); !exists {
Expand All @@ -181,9 +174,7 @@ func initalizeENVVariables() error {
if result == "" {
return errInputPublishResultsEmpty
}
if err := os.Setenv(scorecardPublishResults, result); err != nil {
return fmt.Errorf("error setting %s: %w", scorecardPublishResults, err)
}
scorecardPublishResults = result
}

return gitHubEventPath()
Expand Down Expand Up @@ -296,28 +287,17 @@ func updateRepositoryInformation(privateRepo bool, defaultBranch string) error {
return errEmptyDefaultBranch
}

if err := os.Setenv(scorecardPrivateRepository, strconv.FormatBool(privateRepo)); err != nil {
return fmt.Errorf("error setting %s: %w", scorecardPrivateRepository, err)
}
if err := os.Setenv(scorecardDefaultBranch, fmt.Sprintf("refs/heads/%s", defaultBranch)); err != nil {
return fmt.Errorf("error setting %s: %w", scorecardDefaultBranch, err)
}
scorecardPrivateRepository = strconv.FormatBool(privateRepo)
scorecardDefaultBranch = fmt.Sprintf("refs/heads/%s", defaultBranch)

return nil
}

// updateEnvVariables is a function to update the ENV variables based on results format and private repository.
func updateEnvVariables() error {
resultsFileFormat := os.Getenv(scorecardResultsFormat)
if resultsFileFormat != sarif {
if err := os.Unsetenv(scorecardPolicyFile); err != nil {
return fmt.Errorf("error unsetting %s: %w", scorecardPolicyFile, err)
}
}
isPrivateRepo := os.Getenv(scorecardPrivateRepository)
isPrivateRepo := scorecardPrivateRepository
if isPrivateRepo != "true" {
if err := os.Setenv(scorecardPublishResults, "false"); err != nil {
return fmt.Errorf("error setting %s: %w", scorecardPublishResults, err)
}
scorecardPublishResults = "false"
}
return nil
}
Expand All @@ -329,11 +309,6 @@ func printEnvVariables(writer io.Writer) {
fmt.Fprintf(writer, "GITHUB_REPOSITORY=%s\n", os.Getenv(githubRepository))
fmt.Fprintf(writer, "SCORECARD_IS_FORK=%s\n", os.Getenv(scorecardFork))
fmt.Fprintf(writer, "Ref=%s\n", os.Getenv(githubRef))
fmt.Fprintf(writer, "SCORECARD_PRIVATE_REPOSITORY=%s\n", os.Getenv(scorecardPrivateRepository))
fmt.Fprintf(writer, "SCORECARD_PUBLISH_RESULTS=%s\n", os.Getenv(scorecardPublishResults))
fmt.Fprintf(writer, "Format=%s\n", os.Getenv(scorecardResultsFormat))
fmt.Fprintf(writer, "Policy file=%s\n", os.Getenv(scorecardPolicyFile))
fmt.Fprintf(writer, "Default branch=%s\n", os.Getenv(scorecardDefaultBranch))
}

// validate is a function to validate the scorecard configuration based on the environment variables.
Expand All @@ -349,9 +324,9 @@ func validate(writer io.Writer) error {
return errEmptyGitHubAuthToken
}
if strings.Contains(os.Getenv(githubEventName), "pull_request") &&
os.Getenv(githubRef) == os.Getenv(scorecardDefaultBranch) {
os.Getenv(githubRef) == scorecardDefaultBranch {
fmt.Fprintf(writer, "%s not supported with %s event.\n", os.Getenv(githubRef), os.Getenv(githubEventName))
fmt.Fprintf(writer, "Only the default branch %s is supported.\n", os.Getenv(scorecardDefaultBranch))
fmt.Fprintf(writer, "Only the default branch %s is supported.\n", scorecardDefaultBranch)
return errOnlyDefaultBranchSupported
}
return nil
Expand Down Expand Up @@ -393,7 +368,7 @@ func runScorecardSettings(githubEventName, scorecardPolicyFile, scorecardResults
return &result, nil
}

enabledChecks := ""
enabledChecks = ""
if githubEventName == "branch_protection_rule" {
enabledChecks = "--checks Branch-Protection"
}
Expand Down
14 changes: 4 additions & 10 deletions main_test.go
View file
Open in desktop
Expand Up @@ -204,9 +204,6 @@ func Test_initalizeENVVariables(t *testing.T) {
envvars[enableSarif] = "1"
envvars[enableLicense] = "1"
envvars[enableDangerousWorkflow] = "1"
envvars[scorecardPolicyFile] = "./policy.yml"
envvars[scorecardBin] = "/scorecard"
envvars[enabledChecks] = ""

for k, v := range envvars {
if os.Getenv(k) != v {
Expand Down Expand Up @@ -246,7 +243,7 @@ func Test_updateEnvVariables(t *testing.T) {
t.Errorf("updateEnvVariables() error = %v, wantErr %v", err, tt.wantErr)
}
if !tt.wantErr && tt.isPrivateRepo {
if os.Getenv(scorecardPublishResults) != "false" {
if scorecardPublishResults != "false" {
t.Errorf("scorecardPublishResults env var should be false")
}
}
Expand Down Expand Up @@ -304,12 +301,12 @@ func Test_updateRepoistoryInformation(t *testing.T) {
t.Errorf("updateRepoistoryInformation() error = %v, wantErr %v", err, tt.wantErr)
}
if tt.args.privateRepo {
if os.Getenv(scorecardPrivateRepository) != strconv.FormatBool(tt.args.privateRepo) {
if scorecardPrivateRepository != strconv.FormatBool(tt.args.privateRepo) {
t.Errorf("scorecardPublishResults env var should be false")
}
}
if tt.args.defaultBranch != "" {
if os.Getenv(scorecardDefaultBranch) != fmt.Sprintf("refs/heads/%s", tt.args.defaultBranch) {
if scorecardDefaultBranch != fmt.Sprintf("refs/heads/%s", tt.args.defaultBranch) {
t.Errorf("scorecardDefaultBranch env var should be %s", tt.args.defaultBranch)
}
}
Expand Down Expand Up @@ -467,10 +464,7 @@ func Test_validate(t *testing.T) {
defer os.Unsetenv(githubRef)
}
if tt.scorecardDefaultBranch != "" {
if err := os.Setenv(scorecardDefaultBranch, tt.scorecardDefaultBranch); err != nil {
t.Errorf("failed to set env var %s", scorecardDefaultBranch)
}
defer os.Unsetenv(scorecardDefaultBranch)
scorecardDefaultBranch = tt.scorecardDefaultBranch
}
if tt.authToken != "" {
if err := os.Setenv(githubAuthToken, tt.authToken); err != nil {
Expand Down