feat: Update repo schema (#260)

* fix: Have nuke only run compose stop if nuking docker resources

* feat: Change repo schema to be a struct

cmd/clone.go

@@ -32,8 +32,8 @@ var cloneCmd = &cobra.Command{
 			fatal.Exitf("%s does not have a repo or is a third-party repo\n", serviceName)
 		}
 
-		repoPath := fmt.Sprintf("./%s", strings.Split(s.GitRepo, "/")[1])
-		err = git.Clone(s.GitRepo, repoPath)
+		repoPath := fmt.Sprintf("./%s", strings.Split(s.GitRepo.Name, "/")[1])
+		err = git.Clone(s.GitRepo.Name, repoPath)
 		if err != nil {
 			fatal.ExitErr(err, "Could not run git clone command.")
 		}

cmd/nuke.go

@@ -51,15 +51,21 @@ var nukeCmd = &cobra.Command{
 
 	},
 	Run: func(cmd *cobra.Command, args []string) {
-		// Passing nothing to compose will shut everything down
-		err := docker.ComposeStop(make([]string, 0))
-		if err != nil {
-			fatal.ExitErr(err, "Failed stopping docker compose services.")
+		// Run compose stop before nuking any docker related resources
+		// to ensure no weirdness
+		if nukeOpts.shouldNukeContainers || nukeOpts.shouldNukeImages ||
+			nukeOpts.shouldNukeVolumes || nukeOpts.shouldNukeNetworks ||
+			nukeOpts.shouldNukeAll {
+			// Passing nothing to compose will shut everything down
+			err := docker.ComposeStop(make([]string, 0))
+			if err != nil {
+				fatal.ExitErr(err, "Failed stopping docker compose services.")
+			}
 		}
 
 		if nukeOpts.shouldNukeContainers || nukeOpts.shouldNukeAll {
 			log.Infoln("Stopping running containers...")
-			err = docker.StopAllContainers()
+			err := docker.StopAllContainers()
 			if err != nil {
 				fatal.ExitErr(err, "Failed stopping docker containers")
 			}
@@ -74,7 +80,7 @@ var nukeCmd = &cobra.Command{
 
 		if nukeOpts.shouldNukeImages || nukeOpts.shouldNukeAll {
 			log.Infoln("Removing images...")
-			err = docker.RmImages()
+			err := docker.RmImages()
 			if err != nil {
 				fatal.ExitErr(err, "Failed removing docker images.")
 			}
@@ -83,7 +89,7 @@ var nukeCmd = &cobra.Command{
 
 		if nukeOpts.shouldNukeNetworks || nukeOpts.shouldNukeAll {
 			log.Infoln("Removing networks...")
-			err = docker.RmNetworks()
+			err := docker.RmNetworks()
 			if err != nil {
 				fatal.ExitErr(err, "Failed removing docker networks.")
 			}
@@ -92,7 +98,7 @@ var nukeCmd = &cobra.Command{
 
 		if nukeOpts.shouldNukeVolumes || nukeOpts.shouldNukeAll {
 			log.Infoln("Removing volumes...")
-			err = docker.RmVolumes()
+			err := docker.RmVolumes()
 			if err != nil {
 				fatal.ExitErr(err, "Failed removing docker volumes.")
 			}
@@ -107,7 +113,7 @@ var nukeCmd = &cobra.Command{
 			for it.HasNext() {
 				s := it.Next()
 				if s.HasGitRepo() {
-					repos = append(repos, s.GitRepo)
+					repos = append(repos, s.GitRepo.Name)
 				}
 			}
 			repos = util.UniqueStrings(repos)

cmd/up.go

@@ -323,7 +323,7 @@ Examples:
 			repos := make([]string, 0)
 			for _, s := range selectedServices {
 				if s.HasGitRepo() {
-					repos = append(repos, s.GitRepo)
+					repos = append(repos, s.GitRepo.Name)
 				}
 			}
 			repos = util.UniqueStrings(repos)

compose/compose_test.go

@@ -69,8 +69,10 @@ func TestCreateComposeFile(t *testing.T) {
 			Ports: []string{
 				"8081:8080",
 			},
-			PreRun:  "yarn db:prepare",
-			GitRepo: "TouchBistro/venue-core-service",
+			PreRun: "yarn db:prepare",
+			GitRepo: service.GitRepo{
+				Name: "TouchBistro/venue-core-service",
+			},
 			Build: service.Build{
 				Args: map[string]string{
 					"NODE_ENV":  "development",

config/config.go

@@ -221,7 +221,7 @@ func CloneMissingRepos() error {
 	for it.HasNext() {
 		s := it.Next()
 		if s.HasGitRepo() {
-			repos = append(repos, s.GitRepo)
+			repos = append(repos, s.GitRepo.Name)
 		}
 	}
 	repos = util.UniqueStrings(repos)

config/legacy.go

@@ -67,7 +67,7 @@ func parseServices(config legacyServiceConfig) (map[string]service.Service, erro
 
 		// Set special service specific vars
 		if s.HasGitRepo() {
-			vars["@REPOPATH"] = filepath.Join(ReposPath(), s.GitRepo)
+			vars["@REPOPATH"] = filepath.Join(ReposPath(), s.GitRepo.Name)
 		} else {
 			vars["@REPOPATH"] = ""
 		}

docs/registries.md

@@ -128,7 +128,8 @@ The schema is as follows:
   mode: remote | build         # What mode to use: remote or build
   ports: string[]              # List of ports to expose
   preRun: string               # Script to run before starting the service, e.g. 'yarn db:prepare' to run db migrations
-  repo: string                 # The repo name on GitHub, format: org/repo
+  repo:
+    name: string # The repo name on GitHub, format: org/repo
   build:
     args: map<string, string> # List of args to pass to docker build
     command: string           # Command to run when container starts

registry/registry.go

@@ -144,7 +144,7 @@ func readServices(r Registry, rootPath, reposPath string) ([]service.Service, se
 
 		// Set special service specific vars
 		if s.HasGitRepo() {
-			vars["@REPOPATH"] = filepath.Join(reposPath, s.GitRepo)
+			vars["@REPOPATH"] = filepath.Join(reposPath, s.GitRepo.Name)
 		} else {
 			vars["@REPOPATH"] = ""
 		}

registry/registry_test.go

@@ -81,10 +81,12 @@ func TestReadRegistries(t *testing.T) {
 			"HTTP_PORT": "8080",
 			"DB_HOST":   "touchbistro-tb-registry-postgres",
 		},
-		Mode:    service.ModeRemote,
-		Ports:   []string{"8081:8080"},
-		PreRun:  "yarn db:prepare",
-		GitRepo: "TouchBistro/venue-core-service",
+		Mode:   service.ModeRemote,
+		Ports:  []string{"8081:8080"},
+		PreRun: "yarn db:prepare",
+		GitRepo: service.GitRepo{
+			Name: "TouchBistro/venue-core-service",
+		},
 		Build: service.Build{
 			Args: map[string]string{
 				"NODE_ENV":  "development",
@@ -146,10 +148,12 @@ func TestReadRegistries(t *testing.T) {
 			"HTTP_PORT":     "8000",
 			"POSTGRES_HOST": "examplezone-tb-registry-postgres",
 		},
-		Mode:    service.ModeRemote,
-		Ports:   []string{"9000:8000"},
-		PreRun:  "yarn db:prepare:dev",
-		GitRepo: "ExampleZone/venue-example-service",
+		Mode:   service.ModeRemote,
+		Ports:  []string{"9000:8000"},
+		PreRun: "yarn db:prepare:dev",
+		GitRepo: service.GitRepo{
+			Name: "ExampleZone/venue-example-service",
+		},
 		Build: service.Build{
 			Command:        "yarn start",
 			DockerfilePath: "/home/test/.tb/repos/ExampleZone/venue-example-service",

registry/testdata/invalid-registry-1/services.yml

@@ -17,7 +17,8 @@ services:
     ports:
       - '5432:8080'
     preRun: yarn db:prepare
-    repo: TouchBistro/venue-core-service
+    repo:
+      name: TouchBistro/venue-core-service
     build:
       args:
         NODE_ENV: development

registry/testdata/registry-1/services.yml

@@ -33,7 +33,8 @@ services:
     ports:
       - '8081:8080'
     preRun: yarn db:prepare
-    repo: TouchBistro/venue-core-service
+    repo:
+      name: TouchBistro/venue-core-service
     build:
       args:
         NODE_ENV: development

registry/testdata/registry-2/services.yml

@@ -31,7 +31,8 @@ services:
     ports:
       - '9000:8000'
     preRun: yarn db:prepare:dev
-    repo: ExampleZone/venue-example-service
+    repo:
+      name: ExampleZone/venue-example-service
     build:
       target: build
       command: yarn start

service/service.go

@@ -25,6 +25,10 @@ type Build struct {
 	Volumes        []Volume          `yaml:"volumes"`
 }
 
+type GitRepo struct {
+	Name string `yaml:"name"`
+}
+
 type Remote struct {
 	Command string   `yaml:"command"`
 	Image   string   `yaml:"image"`
@@ -38,7 +42,7 @@ type Service struct {
 	Entrypoint   []string          `yaml:"entrypoint"`
 	EnvFile      string            `yaml:"envFile"`
 	EnvVars      map[string]string `yaml:"envVars"`
-	GitRepo      string            `yaml:"repo"`
+	GitRepo      GitRepo           `yaml:"repo"`
 	Mode         string            `yaml:"mode"`
 	Ports        []string          `yaml:"ports"`
 	PreRun       string            `yaml:"preRun"`
@@ -49,7 +53,7 @@ type Service struct {
 }
 
 func (s Service) HasGitRepo() bool {
-	return s.GitRepo != ""
+	return s.GitRepo.Name != ""
 }
 
 func (s Service) UseRemote() bool {

service/service_test.go

@@ -45,8 +45,10 @@ func createServiceCollection(t *testing.T) *ServiceCollection {
 			Ports: []string{
 				"8081:8080",
 			},
-			PreRun:  "yarn db:prepare:dev",
-			GitRepo: "TouchBistro/venue-core-service",
+			PreRun: "yarn db:prepare:dev",
+			GitRepo: GitRepo{
+				Name: "TouchBistro/venue-core-service",
+			},
 			Build: Build{
 				Args: map[string]string{
 					"NODE_ENV": "development",
@@ -70,8 +72,10 @@ func TestServiceMethods(t *testing.T) {
 	assert := assert.New(t)
 
 	s := Service{
-		GitRepo: "TouchBistro/venue-core-service",
-		Mode:    ModeRemote,
+		GitRepo: GitRepo{
+			Name: "TouchBistro/venue-core-service",
+		},
+		Mode: ModeRemote,
 		Build: Build{
 			DockerfilePath: ".tb/repos/TouchBistro/venue-core-service",
 		},
@@ -104,8 +108,10 @@ func TestNewServiceCollectionOverrides(t *testing.T) {
 			Ports: []string{
 				"8081:8080",
 			},
-			PreRun:  "yarn db:prepare:dev",
-			GitRepo: "TouchBistro/venue-core-service",
+			PreRun: "yarn db:prepare:dev",
+			GitRepo: GitRepo{
+				Name: "TouchBistro/venue-core-service",
+			},
 			Build: Build{
 				Args: map[string]string{
 					"NODE_ENV": "development",
@@ -153,8 +159,10 @@ func TestNewServiceCollectionOverrides(t *testing.T) {
 		Ports: []string{
 			"8081:8080",
 		},
-		PreRun:  "yarn db:prepare",
-		GitRepo: "TouchBistro/venue-core-service",
+		PreRun: "yarn db:prepare",
+		GitRepo: GitRepo{
+			Name: "TouchBistro/venue-core-service",
+		},
 		Build: Build{
 			Args: map[string]string{
 				"NODE_ENV": "development",
@@ -211,8 +219,10 @@ func TestServiceCollectionGetShortName(t *testing.T) {
 		Ports: []string{
 			"8081:8080",
 		},
-		PreRun:  "yarn db:prepare:dev",
-		GitRepo: "TouchBistro/venue-core-service",
+		PreRun: "yarn db:prepare:dev",
+		GitRepo: GitRepo{
+			Name: "TouchBistro/venue-core-service",
+		},
 		Build: Build{
 			Args: map[string]string{
 				"NODE_ENV": "development",