Merge pull request #19 from RedbackThomson/add-repos

Added the add repository command

Author: jaypipes

cmd/ackdev/cmd/add.go

@@ -0,0 +1,27 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package cmd
+
+import "github.com/spf13/cobra"
+
+func init() {
+	addCmd.AddCommand(addRepositoryCmd)
+}
+
+var addCmd = &cobra.Command{
+	Use:     "add",
+	Aliases: []string{},
+	Args:    cobra.NoArgs,
+	Short:   "Creates one or more resources",
+}

cmd/ackdev/cmd/add_repo.go

@@ -0,0 +1,69 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file is distributed
+// on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+// express or implied. See the License for the specific language governing
+// permissions and limitations under the License.
+
+package cmd
+
+import (
+	"errors"
+	"fmt"
+	"strings"
+
+	"github.com/aws-controllers-k8s/dev-tools/pkg/config"
+	"github.com/aws-controllers-k8s/dev-tools/pkg/repository"
+	"github.com/aws-controllers-k8s/dev-tools/pkg/util"
+	"github.com/spf13/cobra"
+)
+
+var (
+	ErrRepositoryAlreadyAdded = errors.New("repository has already been added")
+)
+
+var addRepositoryCmd = &cobra.Command{
+	Use:     "repository <service> ...",
+	Aliases: []string{"repo", "repos", "repository", "repositories"},
+	RunE:    addRepository,
+	Args:    cobra.MinimumNArgs(1),
+}
+
+func addRepository(cmd *cobra.Command, args []string) error {
+	for _, service := range args {
+		service = strings.ToLower(args[0])
+
+		ctx := cmd.Context()
+
+		cfg, err := config.Load(ackConfigPath)
+		if err != nil {
+			return err
+		}
+
+		// Check it doesn't already exist in the configuration
+		if util.InStrings(service, cfg.Repositories.Services) {
+			return ErrRepositoryAlreadyAdded
+		}
+
+		repoManager, err := repository.NewManager(cfg)
+		if err != nil {
+			return err
+		}
+
+		serviceRepoName := fmt.Sprintf("%s-controller", service)
+		if err := repoManager.EnsureRepository(ctx, serviceRepoName); err != nil {
+			return err
+		}
+
+		cfg.Repositories.Services = append(cfg.Repositories.Services, service)
+		config.Save(cfg, ackConfigPath)
+	}
+
+	return nil
+}

cmd/ackdev/cmd/root.go

@@ -29,6 +29,7 @@ func init() {
 
 	rootCmd.AddCommand(listCmd)
 	rootCmd.AddCommand(editCmd)
+	rootCmd.AddCommand(addCmd)
 	rootCmd.AddCommand(versionCmd)
 	rootCmd.AddCommand(setupCmd)
 }

pkg/repository/manager.go

@@ -17,8 +17,8 @@ import (
 	"context"
 	"errors"
 	"fmt"
-	"os"
 	"path/filepath"
+	"strings"
 	"time"
 
 	"github.com/sirupsen/logrus"
@@ -29,7 +29,6 @@ import (
 	"github.com/aws-controllers-k8s/dev-tools/pkg/config"
 	ackdevgit "github.com/aws-controllers-k8s/dev-tools/pkg/git"
 	"github.com/aws-controllers-k8s/dev-tools/pkg/github"
-	"github.com/aws-controllers-k8s/dev-tools/pkg/util"
 )
 
 const (
@@ -90,30 +89,14 @@ type Manager struct {
 }
 
 // LoadRepository loads information about a single local repository
-func (m *Manager) LoadRepository(name string, t RepositoryType) (*Repository, error) {
+func (m *Manager) LoadRepository(name string) (*Repository, error) {
 	// check repo cache
-	repo, err := m.GetRepository(name)
+	repo, err := m.getRepository(name)
 	if err == nil {
 		return repo, nil
 	}
 
-	// fail if repository doesn't exist in the manager configuration
-	switch t {
-	case RepositoryTypeCore:
-		if !util.InStrings(name, m.cfg.Repositories.Core) {
-			return nil, ErrUnconfiguredRepository
-		}
-	case RepositoryTypeController:
-		if !util.InStrings(name, m.cfg.Repositories.Services) {
-			return nil, ErrUnconfiguredRepository
-		}
-	}
-
 	repoName := name
-	// controller repositories should always have a '-controller' suffix
-	if t == RepositoryTypeController {
-		repoName = fmt.Sprintf("%s-controller", name)
-	}
 
 	// set expected fork name
 	expectedForkName := repoName
@@ -137,6 +120,11 @@ func (m *Manager) LoadRepository(name string, t RepositoryType) (*Repository, er
 		gitHead = head.Name().Short()
 	}
 
+	t := RepositoryTypeCore
+	if strings.HasSuffix(name, "-controller") {
+		t = RepositoryTypeController
+	}
+
 	repo = &Repository{
 		Name:             repoName,
 		Type:             t,
@@ -156,22 +144,23 @@ func (m *Manager) LoadRepository(name string, t RepositoryType) (*Repository, er
 func (m *Manager) LoadAll() error {
 	// collect repositories from config
 	for _, coreRepo := range m.cfg.Repositories.Core {
-		_, err := m.LoadRepository(coreRepo, RepositoryTypeCore)
+		_, err := m.LoadRepository(coreRepo)
 		if err != nil {
 			return err
 		}
 	}
 	for _, serviceName := range m.cfg.Repositories.Services {
-		_, err := m.LoadRepository(serviceName, RepositoryTypeController)
+		serviceRepoName := fmt.Sprintf("%s-controller", serviceName)
+		_, err := m.LoadRepository(serviceRepoName)
 		if err != nil {
 			return err
 		}
 	}
 	return nil
 }
 
-// GetRepository return a known repository
-func (m *Manager) GetRepository(repoName string) (*Repository, error) {
+// getRepository returns a repository from the cache
+func (m *Manager) getRepository(repoName string) (*Repository, error) {
 	repo, ok := m.repoCache[repoName]
 	if !ok {
 		return nil, ErrRepositoryNotCached
@@ -185,7 +174,7 @@ func (m *Manager) List(filters ...Filter) []*Repository {
 	repoNames := append(m.cfg.Repositories.Core, m.cfg.Repositories.Services...)
 mainLoop:
 	for _, repoName := range repoNames {
-		repo, err := m.GetRepository(repoName)
+		repo, err := m.LoadRepository(repoName)
 		if err != nil {
 			continue
 		}
@@ -201,19 +190,19 @@ mainLoop:
 
 // Clone clones a known repository to the config root directory
 func (m *Manager) clone(ctx context.Context, repoName string) error {
-	repo, err := m.GetRepository(repoName)
+	repo, err := m.LoadRepository(repoName)
 	if err != nil {
 		return fmt.Errorf("cannot clone repository %s: %v", repoName, err)
 	}
 	if repo.gitRepo != nil {
 		return ErrRepositoryAlreadyExist
 	}
 
-	// clone fork repository
+	// clone fork repository with original name
 	err = m.git.Clone(
 		ctx,
 		m.urlBuilder(m.cfg.Github.Username, repo.ExpectedForkName),
-		repo.ExpectedForkName,
+		repo.FullPath,
 	)
 	if errors.Is(err, transport.ErrAuthenticationRequired) {
 		return ErrUnauthenticated
@@ -276,37 +265,20 @@ func (m *Manager) EnsureFork(ctx context.Context, repo *Repository) error {
 	return err
 }
 
-// used to help mocking os.Rename
-// TODO(hilalymh): Q4 switch to go1.16 os/fs library/interface
-var renameDirectory = os.Rename
-
 func (m *Manager) EnsureClone(ctx context.Context, repo *Repository) error {
 	err := m.clone(ctx, repo.Name)
 	if err != nil && err != ErrRepositoryAlreadyExist {
 		return err
 	}
 
-	// At this point we ensured that the fork repository is cloned. We need to rename it
-	// if there is any fork prefix.
-	if repo.Name != repo.ExpectedForkName {
-
-		newPath := filepath.Join(
-			filepath.Dir(repo.FullPath),
-			repo.Name,
-		)
-		err := renameDirectory(repo.FullPath, newPath)
-		if err != nil {
-			return err
-		}
-	}
-
 	return nil
 }
 
-// EnsureAll ensures one repository.
+// EnsureRepository ensures the current user owns a fork of the given repository
+// and has cloned it.
 func (m *Manager) EnsureRepository(ctx context.Context, name string) error {
-	repo, err := m.GetRepository(name)
-	if err != nil {
+	repo, err := m.LoadRepository(name)
+	if err != nil && err != ErrRepositoryDoesntExist {
 		return err
 	}
 

pkg/repository/repository.go

@@ -21,9 +21,6 @@ import (
 
 // NewRepository returns a pointer to a new repository.
 func NewRepository(name string, repoType RepositoryType) *Repository {
-	if repoType == RepositoryTypeController {
-		name = fmt.Sprintf("%s-controller", name)
-	}
 	return &Repository{
 		Name: name,
 		Type: repoType,