Skip to content

hack/tests/scaffolding/scaffold-memcached.go: always use local SDK dir in CI #1806

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

Merged
merged 1 commit into from
Oct 23, 2019
Merged

hack/tests/scaffolding/scaffold-memcached.go: always use local SDK dir in CI #1806

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 6 additions & 70 deletions hack/tests/scaffolding/scaffold-memcached.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,15 +77,12 @@ func main() {
log.Fatalf("Failed to change to %s directory: (%v)", operatorName, err)
}

replace := getGoModReplace(localSDKPath)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @estroz,

Could you help me understand it better? Here currently we download the PR and ensuring that the Memcached mock data will be created with. However, it is not required since the Travis will already install the PR to then call the tests. So, the goal of it is to use SDK already cloned locally by Travis instead of doing all these steps. Am I right?

If yes, its is /lgtm and /approved for me..

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is correct.

if replace.repo != sdkRepo {
modBytes, err := insertGoModReplace(sdkRepo, replace.repo, replace.ref)
if err != nil {
log.Fatalf("Failed to insert go.mod replace: %v", err)
}
log.Printf("go.mod: %v", string(modBytes))
// Always use the local SDK path in the go.mod "replace" line.
modBytes, err := insertGoModReplaceDir(sdkRepo, localSDKPath)
if err != nil {
log.Fatalf("Failed to insert go.mod replace: %v", err)
}

log.Printf("go.mod: %v", string(modBytes))
cmdOut, err = exec.Command("go", "build", "./...").CombinedOutput()
if err != nil {
log.Fatalf("Command \"go build ./...\" failed after modifying go.mod: %v\nCommand Output:\n%v", err, string(cmdOut))
Expand Down Expand Up @@ -194,65 +191,7 @@ func main() {
}
}

type goModReplace struct {
repo string
ref string
}

// getGoModReplace returns a go.mod replacement that is appropriate based on the build's
// environment to support PR, fork/branch, and local builds.
//
// PR:
// 1. Activate when TRAVIS_PULL_REQUEST_SLUG and TRAVIS_PULL_REQUEST_SHA are set
// 2. Modify go.mod to replace osdk import with github.com/${TRAVIS_PULL_REQUEST_SLUG} ${TRAVIS_PULL_REQUEST_SHA}
//
// Fork/branch:
// 1. Activate when TRAVIS_REPO_SLUG and TRAVIS_COMMIT are set
// 2. Modify go.mod to replace osdk import with github.com/${TRAVIS_REPO_SLUG} ${TRAVIS_COMMIT}
//
// Local:
// 1. Activate when none of the above TRAVIS_* variables are set.
// 2. Modify go.mod to replace osdk import with local filesystem path.
//
func getGoModReplace(localSDKPath string) goModReplace {
// PR environment
prSlug, prSlugOk := os.LookupEnv("TRAVIS_PULL_REQUEST_SLUG")
prSha, prShaOk := os.LookupEnv("TRAVIS_PULL_REQUEST_SHA")
if prSlugOk && prSlug != "" && prShaOk && prSha != "" {
return goModReplace{
repo: fmt.Sprintf("github.com/%s", prSlug),
ref: prSha,
}
}

// Fork/branch environment
slug, slugOk := os.LookupEnv("TRAVIS_REPO_SLUG")
sha, shaOk := os.LookupEnv("TRAVIS_COMMIT")
if slugOk && slug != "" && shaOk && sha != "" {
return goModReplace{
repo: fmt.Sprintf("github.com/%s", slug),
ref: sha,
}
}

// If neither of the above cases is applicable, but one of the TRAVIS_*
// variables is nonetheless set, something unexpected is going on. Log
// the vars and exit.
if prSlugOk || prShaOk || slugOk || shaOk {
log.Printf("TRAVIS_PULL_REQUEST_SLUG='%s', set: %t", prSlug, prSlugOk)
log.Printf("TRAVIS_PULL_REQUEST_SHA='%s', set: %t", prSha, prShaOk)
log.Printf("TRAVIS_REPO_SLUG='%s', set: %t", slug, slugOk)
log.Printf("TRAVIS_COMMIT='%s', set: %t", sha, shaOk)
log.Fatal("Invalid travis environment")
}

// Local environment
return goModReplace{
repo: localSDKPath,
}
}

func insertGoModReplace(repo, path, sha string) ([]byte, error) {
func insertGoModReplaceDir(repo, path string) ([]byte, error) {
modBytes, err := ioutil.ReadFile("go.mod")
if err != nil {
return nil, errors.Wrap(err, "failed to read go.mod")
Expand All @@ -262,9 +201,6 @@ func insertGoModReplace(repo, path, sha string) ([]byte, error) {
modBytes = replaceRe.ReplaceAll(modBytes, nil)
// Append the desired replace to the end of go.mod's bytes.
sdkReplace := fmt.Sprintf("replace %s => %s", repo, path)
if sha != "" {
sdkReplace = fmt.Sprintf("%s %s", sdkReplace, sha)
}
modBytes = append(modBytes, []byte("\n"+sdkReplace)...)
err = ioutil.WriteFile("go.mod", modBytes, fileutil.DefaultFileMode)
if err != nil {
Expand Down