add configurable destination path (#55)

* support copying to alternate dest directory

* update readme

* fix config init

---------

Co-authored-by: Igor Rodionov <goruha@gmail.com>

Author: Matt Calhoun

pkg/atmos/component-helper/00_setup.go

@@ -122,9 +122,16 @@ func (s *TestSuite) BootstrapTempDir(t *testing.T, config *c.Config) {
 }
 
 func (s *TestSuite) CopyComponentToTempDir(t *testing.T, config *c.Config) {
-	s.logPhaseStatus("setup/copy component to temp dir", "started")
+	var destPath string
+	if config.ComponentDestDir != "" {
+		destPath = filepath.Join(config.TempDir, config.ComponentDestDir)
+	} else {
+		destPath = filepath.Join(config.TempDir, "components", "terraform", "target")
+	}
+
+	message := fmt.Sprintf("setup/copy component to temp dir: %s", destPath)
+	s.logPhaseStatus(message, "started")
 
-	destPath := filepath.Join(config.TempDir, "components", "terraform", "target")
 	err := s.copyDirectoryContents(config.SrcDir, destPath)
 	if err != nil {
 		s.logPhaseStatus("setup/copy component to temp dir", "failed")

pkg/atmos/component-helper/README.md

@@ -192,21 +192,34 @@ Finally, The Helper will clean up the temporary directory and any other resource
   component under test and its dependencies. This can be useful for debugging issues with the component or its
   dependencies.
 
+### Custom Component Directory
+
+In some cases, for example where there are a suite of components that need to be tested together, it's not desirable to have the component copied to the `target` directory under `<TEMP_DIR>/components/terraform/target`. In this case, you can specify a custom directory by using the `-component-dest-dir` flag or by creting a custom `SetupSuite()` method on your Test Suite.
+
+```go
+func (s *ExampleTestSuite) SetupSuite() {
+  s.TestSuite.InitConfig()
+  s.TestSuite.Config.ComponentDestDir = "components/terraform/myspecialcomponent"
+  s.TestSuite.SetupSuite()
+}
+```
+
 ## Flags reference
 
-| Flag                       | Description                                           | Default           |
-| -------------------------- | ----------------------------------------------------- | ----------------- |
-| -config                    | The path to the config file                           | test_suite.yaml   |
-| -fixtures-dir              | The path to the fixtures directory                    | fixtures          |
-| -only-deploy-dependencies  | Only run the deploy dependencies phase of tests       | false             |
-| -skip-deploy-component     | Skips running the deploy component phase of tests     | false             |
-| -skip-deploy-dependencies  | Skips running the deploy dependencies phase of tests  | false             |
-| -skip-destroy-component    | Skips running the destroy component phase of tests    | false             |
-| -skip-destroy-dependencies | Skips running the destroy dependencies phase of tests | false             |
-| -skip-enabled-flag-test    | Skips running the Enabled flag test                   | false             |
-| -skip-setup                | Skips running the setup test suite phase of tests     | false             |
-| -skip-teardown             | Skips running the teardown test suite phase of tests  | false             |
-| -skip-vendor               | Skips running the vendor dependencies phase of tests  | false             |
-| -src-dir                   | The path to the component source directory            | src               |
-| -state-dir                 | The path to the terraform state directory             | {temp_dir}/state  |
-| -temp-dir                  | The path to the temp directory                        | {random temp dir} |
+| Flag                       | Description                                                                     | Default                     |
+| -------------------------- | ------------------------------------------------------------------------------- | --------------------------- |
+| -component-dest-dir        | The path to the component destination directory, relative to the temp directory | components/terraform/target |
+| -config                    | The path to the config file                                                     | test_suite.yaml             |
+| -fixtures-dir              | The path to the fixtures directory                                              | fixtures                    |
+| -only-deploy-dependencies  | Only run the deploy dependencies phase of tests                                 | false                       |
+| -skip-deploy-component     | Skips running the deploy component phase of tests                               | false                       |
+| -skip-deploy-dependencies  | Skips running the deploy dependencies phase of tests                            | false                       |
+| -skip-destroy-component    | Skips running the destroy component phase of tests                              | false                       |
+| -skip-destroy-dependencies | Skips running the destroy dependencies phase of tests                           | false                       |
+| -skip-enabled-flag-test    | Skips running the Enabled flag test                                             | false                       |
+| -skip-setup                | Skips running the setup test suite phase of tests                               | false                       |
+| -skip-teardown             | Skips running the teardown test suite phase of tests                            | false                       |
+| -skip-vendor               | Skips running the vendor dependencies phase of tests                            | false                       |
+| -src-dir                   | The path to the component source directory                                      | src                         |
+| -state-dir                 | The path to the terraform state directory                                       | {temp_dir}/state            |
+| -temp-dir                  | The path to the temp directory                                                  | {random temp dir}           |

pkg/atmos/component-helper/config/config.go

@@ -13,6 +13,7 @@ import (
 )
 
 func init() {
+	flag.String("component-dest-dir", "", "The path to the component destination directory, relative to the temp directory")
 	flag.String("config", "test_suite.yaml", "The path to the config file")
 	flag.String("fixtures-dir", "fixtures", "The path to the fixtures directory")
 	flag.Bool("only-deploy-dependencies", true, "Only run the deploy dependencies phase of tests")
@@ -30,6 +31,7 @@ func init() {
 }
 
 type Config struct {
+	ComponentDestDir        string
 	ConfigFilePath          string
 	FixturesDir             string
 	RandomIdentifier        string
@@ -89,9 +91,11 @@ func InitConfig(t *testing.T) *Config {
 
 	viper.SetDefault("ConfigFilePath", "test_suite.yaml")
 	viper.SetDefault("FixturesDir", "fixtures")
+	viper.SetDefault("ComponentDestDir", "")
 
 	randID := random.UniqueId()
 	viper.SetDefault("RandomIdentifier", strings.ToLower(randID))
+
 	viper.SetDefault("OnlyDeployDependencies", false)
 	viper.SetDefault("SkipDeployComponent", false)
 	viper.SetDefault("SkipDeployDependencies", false)
@@ -111,6 +115,9 @@ func InitConfig(t *testing.T) *Config {
 	err := viper.BindPFlags(pflag.CommandLine)
 	require.NoError(t, err)
 
+	err = viper.BindPFlag("ComponentDestDir", pflag.Lookup("component-dest-dir"))
+	require.NoError(t, err)
+
 	err = viper.BindPFlag("ConfigFilePath", pflag.Lookup("config"))
 	require.NoError(t, err)
 
@@ -170,16 +177,5 @@ func InitConfig(t *testing.T) *Config {
 	err = writeConfigWithoutPFlags(viper.GetString("ConfigFilePath"))
 	require.NoError(t, err)
 
-	if config.OnlyDeployDependencies {
-		config.SkipDeployComponent = true
-		config.SkipDeployDependencies = false
-		config.SkipDestroyComponent = true
-		config.SkipDestroyDependencies = true
-		config.SkipEnabledFlagTest = true
-		config.SkipSetupTestSuite = false
-		config.SkipTeardownTestSuite = true
-		config.SkipVendorDependencies = false
-	}
-
 	return config
 }

pkg/atmos/component-helper/suite.go

@@ -112,6 +112,16 @@ func (s *TestSuite) DestroyAtmosComponent(t *testing.T, componentName string, st
 	s.logPhaseStatus(phaseName, "completed")
 }
 
+
+func (s *TestSuite) InitConfig() {
+	t := s.T()
+
+	if s.Config == nil {
+		config := c.InitConfig(t)
+		s.Config = config
+  }
+}
+
 func (s *TestSuite) BeforeTest(suiteName, testName string) {
 	if s.Config.OnlyDeployDependencies {
 		s.T().Skip("Skipping test because OnlyDeployDependencies is true")
@@ -122,8 +132,8 @@ func (s *TestSuite) BeforeTest(suiteName, testName string) {
 func (s *TestSuite) SetupSuite() {
 	t := s.T()
 
-	config := c.InitConfig(t)
-	s.Config = config
+	s.InitConfig()
+	config := s.Config
 
 	if s.Config.SkipSetupTestSuite {
 		s.logPhaseStatus("setup", "skipped")