refactor: isolate + inject DefinitionFetcher
All checks were successful
Pull-Request / tests (pull_request) Successful in 1m36s
Pull-Request / static-analysis (pull_request) Successful in 1m52s
Pull-Request / post-run (pull_request) Successful in 30s

This commit is contained in:
Marc 2024-11-10 11:08:16 -05:00
parent 8bc33870e6
commit 4ff7d75a7d
Signed by: marc
GPG key ID: 048E042F22B5DC79
7 changed files with 105 additions and 22 deletions

View file

@ -18,7 +18,7 @@ func getBuildCommand() *cobra.Command {
if err != nil { if err != nil {
return fmt.Errorf("%+v", err) return fmt.Errorf("%+v", err)
} }
def, err := service_definition.GetServiceDefinition(pathProvided) def, err := service_definition.NewDefinitionFetcher().GetDefinition(pathProvided)
if err != nil { if err != nil {
return fmt.Errorf("Failed to read service definition from file: %+v", err) return fmt.Errorf("Failed to read service definition from file: %+v", err)

View file

@ -49,7 +49,7 @@ func getStartCommand() *cobra.Command {
RunE: func(cmd *cobra.Command, args []string) error { RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context() ctx := cmd.Context()
flags := ctx.Value("flags").(ParsedFlags) flags := ctx.Value("flags").(ParsedFlags)
def, err := service_definition.GetServiceDefinition(flags.definitionPath) def, err := service_definition.NewDefinitionFetcher().GetDefinition(flags.definitionPath)
if err != nil { if err != nil {
return fmt.Errorf("Failed to read service definition: %+v", err) return fmt.Errorf("Failed to read service definition: %+v", err)

21
git/main.go Normal file
View file

@ -0,0 +1,21 @@
package git
import (
"os/exec"
)
type GitClient interface {
Clone(path string, destination string) (string, error)
}
type Git struct{}
func (g Git) Clone(path string, destination string) (string, error) {
cloneCmd := exec.Command("git", "clone", path, destination)
if err := cloneCmd.Run(); err != nil {
return "", err
}
return path, nil
}

View file

@ -3,30 +3,46 @@ package service_definition
import ( import (
"github.com/goccy/go-yaml" "github.com/goccy/go-yaml"
"os" "os"
"os/exec" git "spud/git"
"strings" "strings"
) )
type DefinitionFetcher struct {
Git git.GitClient
}
func NewDefinitionFetcher() DefinitionFetcher {
return DefinitionFetcher{
Git: git.Git{},
}
}
func (f DefinitionFetcher) GetDefinition(path string) (ServiceDefinition, error) {
if strings.HasPrefix(path, "git+") {
return f.getDefinitionFromGit(path)
}
return f.getDefinitionFromFile(path)
}
// Clones the target git repository and uses it as a basis to extract // Clones the target git repository and uses it as a basis to extract
// a service definition. // a service definition.
func getDefinitionFromGit(path string) (ServiceDefinition, error) { func (f DefinitionFetcher) getDefinitionFromGit(path string) (ServiceDefinition, error) {
dir, err := os.MkdirTemp("/tmp", "spud-service-") dir, err := os.MkdirTemp("/tmp", "spud-service-")
if err != nil { if err != nil {
return ServiceDefinition{}, err return ServiceDefinition{}, err
} }
cloneCmd := exec.Command("git", "clone", strings.TrimPrefix(path, "git+"), dir) if _, err := f.Git.Clone(strings.TrimPrefix(path, "git+"), dir); err != nil {
if err := cloneCmd.Run(); err != nil {
return ServiceDefinition{}, err return ServiceDefinition{}, err
} }
return getDefinitionFromFile(dir + "/service.yml") return f.getDefinitionFromFile(dir + "/service.yml")
} }
// Extracts a service definition from the given filepath. // Extracts a service definition from the given filepath.
func getDefinitionFromFile(path string) (ServiceDefinition, error) { func (f DefinitionFetcher) getDefinitionFromFile(path string) (ServiceDefinition, error) {
var definition ServiceDefinition var definition ServiceDefinition
defData, err := os.ReadFile(path) defData, err := os.ReadFile(path)

View file

@ -0,0 +1,58 @@
package service_definition
import (
"os"
"strings"
"testing"
)
type MockGit struct {
calls []string
}
func (g *MockGit) Clone(path string, destination string) (string, error) {
g.calls = append(g.calls, path+":"+destination)
return path, nil
}
func TestGetDefinitionDetectsGitPathPrefix(t *testing.T) {
fetcher := NewDefinitionFetcher()
mockGit := MockGit{}
fetcher.Git = &mockGit
fetcher.GetDefinition("git+https://git.com/owner/repo.git")
if len(mockGit.calls) == 0 {
t.Errorf("Expected at least one call to git, got none.")
}
}
func TestGetDefinitionDefaultsToFilePathIfNoPrefix(t *testing.T) {
defPath := t.TempDir() + "/service.yml"
os.WriteFile(defPath, []byte("name: test-service"), 0755)
fetcher := NewDefinitionFetcher()
def, _ := fetcher.GetDefinition(defPath)
if def.Name != "test-service" {
t.Errorf("Expected mock service name to be 'test-service', got %s instead.", def.Name)
}
}
func TestGetDefinitionGetDefinitionFromGit(t *testing.T) {
fetcher := NewDefinitionFetcher()
mockGit := MockGit{}
fetcher.Git = &mockGit
mockUrl := "https://git.com/owner/repo.git"
fetcher.GetDefinition("git+" + mockUrl)
if !strings.HasPrefix(mockGit.calls[0], mockUrl) {
t.Errorf("Expected git cloning for %s, got %s instead.", mockUrl, mockGit.calls[0])
}
}

View file

@ -1,9 +1,5 @@
package service_definition package service_definition
import (
"strings"
)
type BuildImage struct { type BuildImage struct {
Path string `yaml:"path"` Path string `yaml:"path"`
TagPrefix string `yaml:"tag"` TagPrefix string `yaml:"tag"`
@ -47,11 +43,3 @@ type ServiceDefinition struct {
Containers []ContainerDefinition `yaml:"containers"` Containers []ContainerDefinition `yaml:"containers"`
Ports []PortMapping `yaml:"ports"` Ports []PortMapping `yaml:"ports"`
} }
func GetServiceDefinition(path string) (ServiceDefinition, error) {
if strings.HasPrefix(path, "git+") {
return getDefinitionFromGit(path)
}
return getDefinitionFromFile(path)
}

View file

@ -5,7 +5,7 @@ import (
) )
func TestGetServiceDefinitionFromFileDoesNotExist(t *testing.T) { func TestGetServiceDefinitionFromFileDoesNotExist(t *testing.T) {
_, err := GetServiceDefinition(t.TempDir() + "/not-a-file.yml") _, err := NewDefinitionFetcher().GetDefinition(t.TempDir() + "/not-a-file.yml")
if err == nil { if err == nil {
t.Errorf("Expected error, got nil.") t.Errorf("Expected error, got nil.")