From 352219f062e3160b68922f71bf903794332f3769 Mon Sep 17 00:00:00 2001 From: "Edwin.Avalos" Date: Thu, 22 Dec 2016 11:06:14 -0600 Subject: [PATCH 1/8] Adding submodule code --- main.go | 15 +++++++++++++++ plugin.go | 42 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) diff --git a/main.go b/main.go index d80a411..5298f5e 100644 --- a/main.go +++ b/main.go @@ -2,6 +2,7 @@ package main import ( "encoding/json" + "fmt" "os" "github.com/Sirupsen/logrus" @@ -79,6 +80,12 @@ func main() { Usage: "targets to run apply or plan on", EnvVar: "PLUGIN_TARGETS", }, + + cli.StringFlag{ + Name: "submodules", + Usage: "submodules to override", + EnvVar: "PLUGIN_SUBMODULES", + }, } if err := app.Run(os.Args); err != nil { @@ -111,6 +118,13 @@ func run(c *cli.Context) error { } } + var submodules map[string]map[string]string + if c.String("submodules") != "" { + if err := json.Unmarshal([]byte(c.String("submodules")), &submodules); err != nil { + panic(err) + } + } + plugin := Plugin{ Config: Config{ Remote: remote, @@ -123,6 +137,7 @@ func run(c *cli.Context) error { RootDir: c.String("root_dir"), Parallelism: c.Int("parallelism"), Targets: c.StringSlice("targets"), + Submodules: submodules, }, } diff --git a/plugin.go b/plugin.go index 818b291..ae77b7b 100644 --- a/plugin.go +++ b/plugin.go @@ -1,6 +1,7 @@ package main import ( + "encoding/hex" "fmt" "github.com/Sirupsen/logrus" "github.com/aws/aws-sdk-go/aws/credentials" @@ -8,6 +9,7 @@ import ( "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/sts" "io/ioutil" + "math/rand" "os" "os/exec" "strings" @@ -26,6 +28,7 @@ type ( RootDir string Parallelism int Targets []string + Submodules map[string]map[string]string } Remote struct { @@ -45,6 +48,15 @@ func (p Plugin) Exec() error { var commands []*exec.Cmd remote := p.Config.Remote + + if len(p.Config.Secrets) != 0 { + exportSecrets(p.Config.Secrets) + } + + if len(p.Config.Submodules) != 0 { + submoduleOverride(p.Config.Submodules) + } + if p.Config.Cacert != "" { commands = append(commands, installCaCert(p.Config.Cacert)) } @@ -94,6 +106,36 @@ func installCaCert(cacert string) *exec.Cmd { ) } +func submoduleOverride(submodules map[string]map[string]string) { + allOverrides := []string{} + for moduleName, override := range submodules { + overrideContents := []string{} + for k, v := range override { + overrideString := fmt.Sprintf(` %s = "%s"`, k, v) + overrideContents = append(overrideContents, overrideString) + } + moduleContents := fmt.Sprintf(` +module "%s" { +%s +}`, moduleName, strings.Join(overrideContents, "\n")) + allOverrides = append(allOverrides, moduleContents) + } + fileContents := []byte(strings.Join(allOverrides, "\n")) + randBytes := make([]byte, 16) + rand.Read(randBytes) + fileName := hex.EncodeToString(randBytes) + "_override.tf" + err := ioutil.WriteFile(fileName, fileContents, 0644) + if err != nil { + panic(err) + } +} + +func exportSecrets(secrets map[string]string) { + for k, v := range secrets { + os.Setenv(fmt.Sprintf("%s", k), fmt.Sprintf("%s", os.Getenv(v))) + } +} + func deleteCache() *exec.Cmd { return exec.Command( "rm", From 60fab7d3d7e654ffbbd439f7ac1219534f17be56 Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 11:29:41 -0600 Subject: [PATCH 2/8] Delete temp override file when done --- main.go | 4 ---- plugin.go | 34 ++++++++++++++++++++++++---------- 2 files changed, 24 insertions(+), 14 deletions(-) diff --git a/main.go b/main.go index 5298f5e..f8be5fe 100644 --- a/main.go +++ b/main.go @@ -2,7 +2,6 @@ package main import ( "encoding/json" - "fmt" "os" "github.com/Sirupsen/logrus" @@ -69,18 +68,15 @@ func main() { Usage: "The number of concurrent operations as Terraform walks its graph", EnvVar: "PLUGIN_PARALLELISM", }, - cli.StringFlag{ Name: "env-file", Usage: "source env file", }, - cli.StringSliceFlag{ Name: "targets", Usage: "targets to run apply or plan on", EnvVar: "PLUGIN_TARGETS", }, - cli.StringFlag{ Name: "submodules", Usage: "submodules to override", diff --git a/plugin.go b/plugin.go index ae77b7b..7ac7f76 100644 --- a/plugin.go +++ b/plugin.go @@ -53,8 +53,13 @@ func (p Plugin) Exec() error { exportSecrets(p.Config.Secrets) } + var overridesFileName string if len(p.Config.Submodules) != 0 { - submoduleOverride(p.Config.Submodules) + overridesFileName = submoduleOverride(p.Config.Submodules) + + if overridesFileName != "" { + defer os.Remove(overridesFileName) + } } if p.Config.Cacert != "" { @@ -106,28 +111,37 @@ func installCaCert(cacert string) *exec.Cmd { ) } -func submoduleOverride(submodules map[string]map[string]string) { +func submoduleOverride(submodules map[string]map[string]string) string { allOverrides := []string{} + for moduleName, override := range submodules { overrideContents := []string{} for k, v := range override { - overrideString := fmt.Sprintf(` %s = "%s"`, k, v) - overrideContents = append(overrideContents, overrideString) + overrideContents = append(overrideContents, fmt.Sprintf(` %s = "%s"`, k, v)) } - moduleContents := fmt.Sprintf(` -module "%s" { -%s -}`, moduleName, strings.Join(overrideContents, "\n")) + moduleContents := fmt.Sprintf("module \"%s\" {\n%s\n}", moduleName, strings.Join(overrideContents, "\n")) allOverrides = append(allOverrides, moduleContents) } + fileContents := []byte(strings.Join(allOverrides, "\n")) + randBytes := make([]byte, 16) rand.Read(randBytes) fileName := hex.EncodeToString(randBytes) + "_override.tf" - err := ioutil.WriteFile(fileName, fileContents, 0644) - if err != nil { + + if err := ioutil.WriteFile(fileName, fileContents, 0644); err != nil { panic(err) } + + return fileName +} + +func removeOverridesFile(fileName string) *exec.Cmd { + return exec.Command( + "rm", + "-f", + fileName, + ) } func exportSecrets(secrets map[string]string) { From b8da50792c6ca308dd83f1ed8b74a5ee027b280a Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 11:32:05 -0600 Subject: [PATCH 3/8] Re-order imports to match main.go --- plugin.go | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/plugin.go b/plugin.go index 7ac7f76..428603a 100644 --- a/plugin.go +++ b/plugin.go @@ -3,17 +3,18 @@ package main import ( "encoding/hex" "fmt" - "github.com/Sirupsen/logrus" - "github.com/aws/aws-sdk-go/aws/credentials" - "github.com/aws/aws-sdk-go/aws/credentials/stscreds" - "github.com/aws/aws-sdk-go/aws/session" - "github.com/aws/aws-sdk-go/service/sts" "io/ioutil" "math/rand" "os" "os/exec" "strings" "time" + + "github.com/Sirupsen/logrus" + "github.com/aws/aws-sdk-go/aws/credentials" + "github.com/aws/aws-sdk-go/aws/credentials/stscreds" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/aws/aws-sdk-go/service/sts" ) type ( From aeb69861ba78410a1785770d15ecb90e350a5332 Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 11:34:22 -0600 Subject: [PATCH 4/8] Add more verbose error --- plugin.go | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/plugin.go b/plugin.go index 428603a..93a2893 100644 --- a/plugin.go +++ b/plugin.go @@ -131,7 +131,9 @@ func submoduleOverride(submodules map[string]map[string]string) string { fileName := hex.EncodeToString(randBytes) + "_override.tf" if err := ioutil.WriteFile(fileName, fileContents, 0644); err != nil { - panic(err) + logrus.WithFields(logrus.Fields{ + "error": err, + }).Fatal("Error writing overrides file!") } return fileName From cc93a966b0c1cf0978a1c98b6f0952564c27b3c6 Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 11:34:56 -0600 Subject: [PATCH 5/8] Remove old code --- plugin.go | 8 -------- 1 file changed, 8 deletions(-) diff --git a/plugin.go b/plugin.go index 93a2893..7109ed5 100644 --- a/plugin.go +++ b/plugin.go @@ -139,14 +139,6 @@ func submoduleOverride(submodules map[string]map[string]string) string { return fileName } -func removeOverridesFile(fileName string) *exec.Cmd { - return exec.Command( - "rm", - "-f", - fileName, - ) -} - func exportSecrets(secrets map[string]string) { for k, v := range secrets { os.Setenv(fmt.Sprintf("%s", k), fmt.Sprintf("%s", os.Getenv(v))) From cff2aaafffdf3c0285d57572f51b607ac21c1ad7 Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 11:36:40 -0600 Subject: [PATCH 6/8] Limit var scope --- plugin.go | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/plugin.go b/plugin.go index 7109ed5..036864c 100644 --- a/plugin.go +++ b/plugin.go @@ -54,9 +54,8 @@ func (p Plugin) Exec() error { exportSecrets(p.Config.Secrets) } - var overridesFileName string if len(p.Config.Submodules) != 0 { - overridesFileName = submoduleOverride(p.Config.Submodules) + overridesFileName := submoduleOverride(p.Config.Submodules) if overridesFileName != "" { defer os.Remove(overridesFileName) From f8a287c6c1ed2e50cab893b9b255e6351062ced2 Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 12:36:37 -0600 Subject: [PATCH 7/8] Update docs --- DOCS.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/DOCS.md b/DOCS.md index 8f0ed90..a9e5937 100644 --- a/DOCS.md +++ b/DOCS.md @@ -187,3 +187,33 @@ pipeline: app_version: 1.0.0 parallelism: 2 ``` + +## Submodule Overrides +You may want to override particular configuration values in submodules. + +For example, this configuration: + +```yaml +pipeline: + terraform: + image: jmccann/drone-terraform:0.5 + plan: false + submodules: + the-first: + source: some:neat://path + a-key: key + the-second: + do-the-thing: true + parallelism: 2 +``` + +will add a file named `_override.tf` containing: +```hcl-terraform +module "the-first" { + source = "some:neat://path" + a-key = "key" +} +module "the-second" { + do-the-thing = true +} +``` \ No newline at end of file From 726cb59f0280cedbbb36feedfc2d54593be6dd65 Mon Sep 17 00:00:00 2001 From: Greyson Dehn Date: Thu, 22 Dec 2016 14:32:51 -0600 Subject: [PATCH 8/8] remove some extra stuff --- plugin.go | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/plugin.go b/plugin.go index 036864c..88152a4 100644 --- a/plugin.go +++ b/plugin.go @@ -50,10 +50,6 @@ func (p Plugin) Exec() error { var commands []*exec.Cmd remote := p.Config.Remote - if len(p.Config.Secrets) != 0 { - exportSecrets(p.Config.Secrets) - } - if len(p.Config.Submodules) != 0 { overridesFileName := submoduleOverride(p.Config.Submodules) @@ -65,15 +61,18 @@ func (p Plugin) Exec() error { if p.Config.Cacert != "" { commands = append(commands, installCaCert(p.Config.Cacert)) } + if remote.Backend != "" { commands = append(commands, deleteCache()) commands = append(commands, remoteConfigCommand(remote)) } + commands = append(commands, getModules()) commands = append(commands, planCommand(p.Config.Vars, p.Config.Secrets, p.Config.Parallelism, p.Config.Targets)) if !p.Config.Plan { commands = append(commands, applyCommand(p.Config.Parallelism, p.Config.Targets)) } + commands = append(commands, deleteCache()) for _, c := range commands { @@ -138,12 +137,6 @@ func submoduleOverride(submodules map[string]map[string]string) string { return fileName } -func exportSecrets(secrets map[string]string) { - for k, v := range secrets { - os.Setenv(fmt.Sprintf("%s", k), fmt.Sprintf("%s", os.Getenv(v))) - } -} - func deleteCache() *exec.Cmd { return exec.Command( "rm",