Implement rv release flow

Author: kkentzo

cmd/common_test.go

@@ -0,0 +1,81 @@
+package cmd
+
+import (
+	"archive/zip"
+	"bytes"
+	"errors"
+	"fmt"
+	"os"
+	"regexp"
+
+	"github.com/google/uuid"
+	"github.com/spf13/cobra"
+)
+
+// ================
+// HELPER FUNCTIONS
+// ================
+func createRelease(workspacePath, includedFile string) (string, error) {
+	// create bundle
+	bundlePath := fmt.Sprintf("%s.zip", uuid.NewString())
+	defer deleteBundle(bundlePath)
+	if err := createBundle(bundlePath, includedFile); err != nil {
+		return "", err
+	}
+
+	// prepare command
+	cmdOutput := createOutputBuffer(RootCmd)
+	RootCmd.SetArgs([]string{"release", "-w", workspacePath, bundlePath})
+	// FIRE!
+	RootCmd.Execute()
+
+	// get release ID from command output
+	return parseReleaseId(cmdOutput.String()), nil
+}
+
+func createOutputBuffer(cmd *cobra.Command) *bytes.Buffer {
+	actual := new(bytes.Buffer)
+	cmd.SetOut(actual)
+	cmd.SetErr(actual)
+	return actual
+}
+
+func parseReleaseId(cmdOutput string) string {
+	pattern := `\b\d{14}\.\d{3}\b`
+	// Compile the regular expression
+	re := regexp.MustCompile(pattern)
+	return re.FindString(cmdOutput)
+}
+
+func fileExists(filename string) bool {
+	_, err := os.Stat(filename)
+	return !os.IsNotExist(err)
+}
+
+func createBundle(zipFileName, includedFileName string) error {
+	outFile, err := os.Create(zipFileName)
+	if err != nil {
+		return err
+	}
+
+	w := zip.NewWriter(outFile)
+
+	if _, err := w.Create(includedFileName); err != nil {
+		return fmt.Errorf("failed to include %s to zip file", zipFileName)
+	}
+
+	if err := w.Close(); err != nil {
+		_ = outFile.Close()
+		return errors.New("Warning: closing zipfile writer failed: " + err.Error())
+	}
+
+	if err := outFile.Close(); err != nil {
+		return errors.New("Warning: closing zipfile failed: " + err.Error())
+	}
+
+	return nil
+}
+
+func deleteBundle(fname string) error {
+	return os.Remove(fname)
+}

cmd/release.go

@@ -3,24 +3,28 @@ package cmd
 import (
 	"fmt"
 
+	"github.com/kkentzo/rv/release"
 	"github.com/spf13/cobra"
 )
 
 // releaseCmd represents the release command
 var (
-	releaseCmdDescription = "Uncompress the specified bundle into the release folder and update the `current` link"
+	releaseCmdDescription = "Uncompress the specified bundle into the workspace and update the `current` link"
 	releaseCmd            = &cobra.Command{
 		Use:   "release",
 		Short: releaseCmdDescription,
 		Long:  releaseCmdDescription,
 		Args:  cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
-			bundlePath := args[0]
-			fmt.Printf("release command called with bundle_path=%s [workspace=%s]", bundlePath, rootDirectory)
+			if releaseID, err := release.Install(workspacePath, args[0]); err != nil {
+				fmt.Fprintf(cmd.OutOrStderr(), "error: %v\n", err)
+			} else {
+				fmt.Fprintln(cmd.OutOrStdout(), releaseID)
+			}
 		},
 	}
 )
 
 func init() {
-	rootCmd.AddCommand(releaseCmd)
+	RootCmd.AddCommand(releaseCmd)
 }

cmd/release_test.go

@@ -0,0 +1,78 @@
+package cmd
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
+	"testing"
+	"time"
+
+	"github.com/google/uuid"
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_Release_ShouldCreateResources_FromScratch(t *testing.T) {
+	// do not create the workspace -- just specify the path
+	workspacePath := uuid.NewString()
+	// ensure that we'll clean up
+	defer os.RemoveAll(workspacePath)
+
+	// create and execute release
+	releaseId, err := createRelease(workspacePath, "foo.txt")
+	assert.NoError(t, err)
+
+	// the workspace should now be present
+	assert.DirExists(t, workspacePath)
+	// the workspace should contain the release (extracted bundle under a versioned directory)
+	assert.DirExists(t, path.Join(workspacePath, releaseId))
+	// the release should have the correct contents
+	assert.FileExists(t, path.Join(workspacePath, releaseId, "foo.txt"))
+	// the workspace should contain the "current" release link
+	assert.FileExists(t, path.Join(workspacePath, "current"))
+	// the "current" release link should point to the release folder
+	assert.FileExists(t, path.Join(workspacePath, "current", "foo.txt"))
+}
+
+func Test_Release_ShouldCleanUp_WhenBundleDoesNotExist(t *testing.T) {
+	workspacePath := uuid.NewString()
+	// ensure that we'll clean up
+	defer os.RemoveAll(workspacePath)
+
+	// DO NOT create this bundle
+	bundlePath := fmt.Sprintf("%s.zip", uuid.NewString())
+
+	// prepare and execute command
+	RootCmd.SetArgs([]string{"release", "-w", workspacePath, bundlePath})
+	// FIRE!
+	RootCmd.Execute()
+
+	// the workspace will not be cleared up
+	assert.DirExists(t, workspacePath)
+	// the workspace directory should be empty
+	entries, err := ioutil.ReadDir(workspacePath)
+	assert.NoError(t, err)
+	assert.Empty(t, entries)
+	// the workspace should NOT contain the "current" release link
+	assert.NoFileExists(t, path.Join(workspacePath, "current"))
+}
+
+func Test_Release_ShouldUpdateCurrent_WhenPreviousReleaseExists(t *testing.T) {
+	workspacePath := uuid.NewString()
+	defer os.RemoveAll(workspacePath)
+
+	// === create the first release ===
+	// create and execute release
+	releaseId, err := createRelease(workspacePath, "foo.txt")
+	assert.NoError(t, err)
+	assert.FileExists(t, path.Join(workspacePath, releaseId, "foo.txt"))
+	assert.FileExists(t, path.Join(workspacePath, "current", "foo.txt"))
+
+	time.Sleep(10 * time.Millisecond)
+
+	// === create the second release ===
+	releaseId, err = createRelease(workspacePath, "bar.txt")
+	assert.NoError(t, err)
+	assert.FileExists(t, path.Join(workspacePath, releaseId, "bar.txt"))
+	assert.FileExists(t, path.Join(workspacePath, "current", "bar.txt"))
+}

cmd/root.go

@@ -8,10 +8,10 @@ import (
 
 var (
 	// persistent (global) command-line arguments
-	rootDirectory string
+	workspacePath string
 	// command
-	rootCmdDescription = "Manage local releases"
-	rootCmd            = &cobra.Command{
+	rootCmdDescription = "Manage multiple release bundles locally"
+	RootCmd            = &cobra.Command{
 		Use:   "rv",
 		Short: rootCmdDescription,
 		Long:  rootCmdDescription,
@@ -21,14 +21,14 @@ var (
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
 func Execute() {
-	err := rootCmd.Execute()
+	err := RootCmd.Execute()
 	if err != nil {
 		os.Exit(1)
 	}
 }
 
 func init() {
-	rootCmd.PersistentFlags().
-		StringVarP(&rootDirectory, "workspace", "w", "", "directory under which releases will be located and managed")
-	rootCmd.MarkPersistentFlagRequired("workspace")
+	RootCmd.PersistentFlags().
+		StringVarP(&workspacePath, "workspace", "w", "", "directory that contains all available releases")
+	RootCmd.MarkPersistentFlagRequired("workspace")
 }

go.mod

@@ -2,9 +2,16 @@ module github.com/kkentzo/rv
 
 go 1.20
 
-require github.com/spf13/cobra v1.8.0
+require (
+	github.com/google/uuid v1.6.0
+	github.com/spf13/cobra v1.8.0
+	github.com/stretchr/testify v1.9.0
+)
 
 require (
+	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.sum

@@ -1,10 +1,20 @@
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
 github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

release/release.go

@@ -0,0 +1,88 @@
+package release
+
+import (
+	"archive/zip"
+	"fmt"
+	"io"
+	"os"
+	"path"
+	"path/filepath"
+	"time"
+)
+
+func Install(workspaceDir, bundlePath string) (string, error) {
+	// create release under workspace
+	id := time.Now().Format("20060102150405.000")
+	releaseDir := path.Join(workspaceDir, id)
+	if err := os.MkdirAll(releaseDir, 0755); err != nil {
+		return id, fmt.Errorf("failed to create release: %v", err)
+	}
+	// decompress bundle file
+	if err := decompressZip(bundlePath, releaseDir); err != nil {
+		// cleanup release directory
+		defer os.RemoveAll(releaseDir)
+		return id, fmt.Errorf("failed to decompress archive: %v", err)
+	}
+	// update current link
+	if err := createOrUpdateLink(workspaceDir, id); err != nil {
+		// cleanup release directory
+		defer os.RemoveAll(releaseDir)
+		return id, fmt.Errorf("failed to create/update link: %v", err)
+	}
+	return id, nil
+}
+
+func createOrUpdateLink(workspaceDir, target string) error {
+	link := path.Join(workspaceDir, "current")
+	// does the link already exist?
+	_, err := os.Stat(link)
+	if !os.IsNotExist(err) {
+		os.Remove(link)
+	}
+	return os.Symlink(target, link)
+}
+
+func decompressZip(zipFile, targetDir string) error {
+	// Open the zip archive for reading
+	r, err := zip.OpenReader(zipFile)
+	if err != nil {
+		return err
+	}
+	defer r.Close()
+
+	// Create the target directory if it doesn't exist
+	if err := os.MkdirAll(targetDir, 0755); err != nil {
+		return err
+	}
+
+	// Iterate through each file in the archive
+	for _, file := range r.File {
+		// Open the file inside the zip archive
+		rc, err := file.Open()
+		if err != nil {
+			return err
+		}
+		defer rc.Close()
+
+		// Create the corresponding file in the target directory
+		targetFilePath := filepath.Join(targetDir, file.Name)
+		if file.FileInfo().IsDir() {
+			// Create directories if file is a directory
+			os.MkdirAll(targetFilePath, file.Mode())
+		} else {
+			// Create the file if it doesn't exist
+			targetFile, err := os.OpenFile(targetFilePath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, file.Mode())
+			if err != nil {
+				return err
+			}
+			defer targetFile.Close()
+
+			// Copy contents from the file inside the zip archive to the target file
+			if _, err := io.Copy(targetFile, rc); err != nil {
+				return err
+			}
+		}
+	}
+
+	return nil
+}