-
Notifications
You must be signed in to change notification settings - Fork 504
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
Initial changes for e2e testing framework #553
Merged
kanchwala-yusuf
merged 2 commits into
tenable:master
from
patilpankaj212:testing-framework
Feb 19, 2021
Merged
Changes from all commits
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
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
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
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
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
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
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,9 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -o errexit | ||
| set -o nounset | ||
| set -o pipefail | ||
|
|
||
| export TERRASCAN_BIN_PATH=${PWD}/bin/terrascan | ||
|
|
||
| go test -v ./test/... |
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,2 @@ | ||
| [policy] | ||
| branch = "invalid-branch" |
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,2 @@ | ||
| [policy] | ||
| path = "invalid/path" |
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,2 @@ | ||
| [policy] | ||
| rego_subdir = "invalid/path" |
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,2 @@ | ||
| [policy] | ||
| repo_url = "https://repository/url" |
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,3 @@ | ||
| [policy] | ||
| repo_url = "https://github.com/accurics/KaiMonkey.git" | ||
| branch = "master" |
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,15 @@ | ||
| Terrascan | ||
|
|
||
| Initializes Terrascan and clones policies from the Terrascan GitHub repository. | ||
|
|
||
| Usage: | ||
| terrascan init [flags] | ||
|
|
||
| Flags: | ||
| -h, --help help for init | ||
|
|
||
| Global Flags: | ||
| -c, --config-path string config file path | ||
| -l, --log-level string log level (debug, info, warn, error, panic, fatal) (default "info") | ||
| -x, --log-type string log output type (console, json) (default "console") | ||
| -o, --output string output type (human, json, yaml, xml, junit-xml) (default "human") |
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,6 @@ | ||
| Error: unknown command "inti" for "terrascan" | ||
|
|
||
| Did you mean this? | ||
| init | ||
|
|
||
| Run 'terrascan --help' for usage. |
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,13 @@ | ||
| package init_test | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| . "github.com/onsi/ginkgo" | ||
| . "github.com/onsi/gomega" | ||
| ) | ||
|
|
||
| func TestInit(t *testing.T) { | ||
| RegisterFailHandler(Fail) | ||
| RunSpecs(t, "Init Suite") | ||
| } |
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,202 @@ | ||
| package init_test | ||
|
|
||
| import ( | ||
| "io" | ||
| "os" | ||
| "path/filepath" | ||
| "time" | ||
|
|
||
| initUtil "github.com/accurics/terrascan/test/e2e/init" | ||
| "github.com/accurics/terrascan/test/helper" | ||
| . "github.com/onsi/ginkgo" | ||
| . "github.com/onsi/gomega" | ||
| "github.com/onsi/gomega/gbytes" | ||
| "github.com/onsi/gomega/gexec" | ||
| "gopkg.in/src-d/go-git.v4" | ||
| ) | ||
|
|
||
| var ( | ||
| initCommand string = "init" | ||
| defaultPolicyRepoPath string = os.Getenv("HOME") + "/.terrascan" | ||
| terrascanGitURL string = "https://github.com/accurics/terrascan.git" | ||
| terrascanDefaultBranch string = "master" | ||
| terrascanConfigEnvName string = "TERRASCAN_CONFIG" | ||
| kaiMoneyGitURL string = "https://github.com/accurics/KaiMonkey.git" | ||
| ) | ||
|
|
||
| var _ = Describe("Init", func() { | ||
| var session *gexec.Session | ||
| var terrascanBinaryPath string | ||
|
|
||
| var outWriter, errWriter io.Writer | ||
|
|
||
| BeforeSuite(func() { | ||
| os.RemoveAll(defaultPolicyRepoPath) | ||
| terrascanBinaryPath = helper.GetTerrascanBinaryPath() | ||
| }) | ||
|
|
||
| BeforeEach(func() { | ||
| outWriter = gbytes.NewBuffer() | ||
| errWriter = gbytes.NewBuffer() | ||
| }) | ||
|
|
||
| AfterEach(func() { | ||
| outWriter = nil | ||
| errWriter = nil | ||
| }) | ||
|
|
||
| Describe("terrascan init is run", func() { | ||
| When("without any flags", func() { | ||
| It("should download policies and exit with status code 0", func() { | ||
| session = initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 0) | ||
| Expect(outWriter).Should(gbytes.Say("")) | ||
| }) | ||
|
|
||
| It("should download policies at TERRASCAN's base location", func() { | ||
| BeADirectory().Match(defaultPolicyRepoPath) | ||
| }) | ||
|
|
||
| Context("git repo should be validated", func() { | ||
| var repo *git.Repository | ||
| var err error | ||
| It("should be a valid git repo", func() { | ||
| repo = initUtil.OpenGitRepo(defaultPolicyRepoPath) | ||
| }) | ||
| It("should be terrascan git repo", func() { | ||
| initUtil.ValidateGitRepo(repo, terrascanGitURL) | ||
| }) | ||
| It("master branch should be present", func() { | ||
| _, err = repo.Branch(terrascanDefaultBranch) | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| When("terrascan init is run with -h flag", func() { | ||
| It("should print help", func() { | ||
| session = helper.RunCommand(terrascanBinaryPath, outWriter, errWriter, initCommand, "-h") | ||
| goldenFileAbsPath, err := filepath.Abs("golden/init_help.txt") | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| helper.CompareActualWithGolden(session, goldenFileAbsPath, true) | ||
| }) | ||
|
|
||
| It("should exit with status code 0", func() { | ||
| session = helper.RunCommand(terrascanBinaryPath, outWriter, errWriter, initCommand, "-h") | ||
| Eventually(session).Should(gexec.Exit(0)) | ||
| }) | ||
| }) | ||
|
|
||
| When("terrascan init command has typo. eg: inti", func() { | ||
| It("should print command suggestion", func() { | ||
| session = helper.RunCommand(terrascanBinaryPath, outWriter, errWriter, "inti") | ||
| goldenFileAbsPath, err := filepath.Abs("golden/init_typo_help.txt") | ||
| Expect(err).NotTo(HaveOccurred()) | ||
| helper.CompareActualWithGolden(session, goldenFileAbsPath, false) | ||
| }) | ||
|
|
||
| It("should exit with status code 1", func() { | ||
| session = helper.RunCommand(terrascanBinaryPath, outWriter, errWriter, "inti") | ||
| Eventually(session, 5).Should(gexec.Exit(1)) | ||
| }) | ||
| }) | ||
|
|
||
| When("terrascan init is run with -c flag", func() { | ||
| Context("config file has valid policy config data", func() { | ||
| It("should download policies as per the policy config in the config file", func() { | ||
| Skip("skipping this test due to https://github.com/accurics/terrascan/issues/550, should be implemented when fixed") | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| Describe("terrascan init is run when TERRASCAN_CONFIG is set", func() { | ||
| When("the config file has invalid repo url", func() { | ||
| JustBeforeEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "config/invalid_repo.toml") | ||
| }) | ||
| JustAfterEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "") | ||
| }) | ||
| It("should error out and exit with status code 1", func() { | ||
| session = initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 1) | ||
| helper.ContainsErrorSubString(session, `failed to download policies. error: 'Get "https://repository/url/info/refs?service=git-upload-pack": dial tcp:`) | ||
| }) | ||
| }) | ||
| When("the config file has invalid branch name", func() { | ||
| JustBeforeEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "config/invalid_branch.toml") | ||
| }) | ||
| JustAfterEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "") | ||
| }) | ||
| It("should error out and exit with status code 1", func() { | ||
| session = initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 1) | ||
| helper.ContainsErrorSubString(session, `failed to initialize terrascan. error : failed to checkout git branch 'invalid-branch'. error: 'reference not found'`) | ||
| }) | ||
| }) | ||
| When("the config file has invalid rego subdir", func() { | ||
| JustBeforeEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "config/invalid_rego_subdir.toml") | ||
| }) | ||
| JustAfterEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "") | ||
| }) | ||
| It("should error out and exit with status code 1", func() { | ||
| session = initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 1) | ||
| helper.ContainsErrorSubString(session, "invalid/path: no such file or directory") | ||
| }) | ||
| }) | ||
| When("the config file has invalid path", func() { | ||
| JustBeforeEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "config/invalid_path.toml") | ||
| }) | ||
| JustAfterEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "") | ||
| }) | ||
| It("should should download policies and exit with status code 0", func() { | ||
| initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 0) | ||
| }) | ||
| }) | ||
| Context("the config file has valid data", func() { | ||
| When("config file has different git repo and branch", func() { | ||
| JustBeforeEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "config/valid_config.toml") | ||
| }) | ||
| JustAfterEach(func() { | ||
| os.Setenv(terrascanConfigEnvName, "") | ||
| }) | ||
| It("init should download the repo provided in the config file", func() { | ||
| initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 0) | ||
| }) | ||
| Context("Kai Monkey git repo is downloaded", func() { | ||
| It("should validate Kai Monkey repo in the policy path", func() { | ||
| repo := initUtil.OpenGitRepo(defaultPolicyRepoPath) | ||
| initUtil.ValidateGitRepo(repo, kaiMoneyGitURL) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
|
|
||
| Describe("terrascan init is run multiple times", func() { | ||
| Context("init clones the git repo to a temp dir, deletes policy path and renames tempdir to policy path", func() { | ||
| Context("running init the first time", func() { | ||
| var modifiedTime time.Time | ||
| It("should download policies at the default policy path", func() { | ||
| initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 0) | ||
| fi, err := os.Stat(defaultPolicyRepoPath) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
| modifiedTime = fi.ModTime() | ||
| }) | ||
| Context("running init the second time", func() { | ||
| It("should download policies again at the default policy path", func() { | ||
| initUtil.RunInitCommand(terrascanBinaryPath, outWriter, errWriter, 0) | ||
| fi, err := os.Stat(defaultPolicyRepoPath) | ||
| Expect(err).ToNot(HaveOccurred()) | ||
| Expect(fi.ModTime()).To(BeTemporally(">", modifiedTime)) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
| }) | ||
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.
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.
we should make changes to return a more specific error message for erranous rego subdir.
Not to be fixed in this PR though.