[ACI-3750] Add activate command

cmd/activate.go

@@ -0,0 +1,17 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+)
+
+// activateCmd represents the activate command
+var activateCmd = &cobra.Command{ //nolint:gochecknoglobals
+	Use:   "activate",
+	Short: "Activate various bitrise plugins",
+	Long: `Activate Gradle, Bazel, etc. plugins
+Call the subcommands with the name of the tool you want to activate plugins for.`,
+}
+
+func init() {
+	rootCmd.AddCommand(activateCmd)
+}

cmd/activate_for_gradle.go

@@ -0,0 +1,113 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	gradleconfig "github.com/bitrise-io/bitrise-build-cache-cli/internal/config/gradle"
+	"github.com/bitrise-io/go-utils/v2/log"
+	"github.com/bitrise-io/go-utils/v2/pathutil"
+	"github.com/spf13/cobra"
+)
+
+const (
+	errFmtFailedToUpdateProps = `failed to update gradle.properties: %w"`
+)
+
+// activateForGradleCmd represents the `gradle` subcommand under `activate`
+var activateForGradleCmd = &cobra.Command{ //nolint:gochecknoglobals
+	Use:   "gradle",
+	Short: "Activate Bitrise Plugins for Gradle",
+	Long: `Activate Bitrise Plugins for Gradle.
+This command will:
+
+- Create a ~/.gradle/init.d/bitrise-build-cache.init.gradle.kts file with the necessary configs. This file will be overwritten.
+- Create a ~/.gradle/gradle.properties file with org.gradle.caching=true when adding the caching plugin.
+
+The gradle.properties file will be created if it doesn't exist.
+If it already exists a "# [start/end] generated-by-bitrise-build-cache" block will be added to the end of the file.
+If the "# [start/end] generated-by-bitrise-build-cache" block is already present in the file then only the block's content will be modified.
+`,
+	SilenceUsage: true,
+	RunE: func(cmd *cobra.Command, _ []string) error {
+		logger := log.NewLogger()
+		logger.EnableDebugLog(isDebugLogMode)
+		logger.TInfof("Activate Bitrise plugins for Gradle")
+
+		gradleHome, err := pathutil.NewPathModifier().AbsPath(gradleHomeNonExpanded)
+		if err != nil {
+			return fmt.Errorf("expand Gradle home path (%s), error: %w", gradleHome, err)
+		}
+
+		if err := getPlugins(cmd.Context(), logger, os.Getenv); err != nil {
+			return fmt.Errorf("failed to fetch plugins: %w", err)
+		}
+
+		if err := activateForGradleCmdFn(
+			logger,
+			gradleHome,
+			os.Getenv,
+			gradleconfig.GlobalActivateForGradleParams.TemplateInventory,
+			func(inventory gradleconfig.TemplateInventory,
+				logger log.Logger,
+				path string,
+				osProxy gradleconfig.OsProxy,
+				templateProxy gradleconfig.TemplateProxy,
+			) error {
+				return inventory.WriteToGradleInit(logger, path, osProxy, templateProxy)
+			},
+			gradleconfig.DefaultGradlePropertiesUpdater(),
+		); err != nil {
+			return fmt.Errorf("activate plugins for Gradle: %w", err)
+		}
+
+		logger.TInfof("✅ Bitrise plugins activated")
+
+		return nil
+	},
+}
+
+func init() {
+	activateCmd.AddCommand(activateForGradleCmd)
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.Cache.Enabled, "cache", gradleconfig.GlobalActivateForGradleParams.Cache.Enabled, "Activate cache plugin. Will override cache-dep.")
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.Cache.JustDependency, "cache-dep", gradleconfig.GlobalActivateForGradleParams.Cache.JustDependency, "Add cache plugin as a dependency only.")
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.Cache.PushEnabled, "cache-push", gradleconfig.GlobalActivateForGradleParams.Cache.PushEnabled, "Push enabled/disabled. Enabled means the build can also write new entries to the remote cache. Disabled means the build can only read from the remote cache.")
+	activateForGradleCmd.Flags().StringVar(&gradleconfig.GlobalActivateForGradleParams.Cache.ValidationLevel, "cache-validation", gradleconfig.GlobalActivateForGradleParams.Cache.ValidationLevel, "Level of cache entry validation for both uploads and downloads. Possible values: none, warning, error")
+	activateForGradleCmd.Flags().StringVar(&gradleconfig.GlobalActivateForGradleParams.Cache.Endpoint, "cache-endpoint", gradleconfig.GlobalActivateForGradleParams.Cache.Endpoint, "The endpoint can be manually provided here for caching operations.")
+
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.Analytics.Enabled, "analytics", gradleconfig.GlobalActivateForGradleParams.Analytics.Enabled, "Activate analytics plugin. Will override analytics-dep.")
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.Analytics.JustDependency, "analytics-dep", gradleconfig.GlobalActivateForGradleParams.Analytics.JustDependency, "Add analytics plugin as a dependency only.")
+
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.TestDistro.Enabled, "test-distribution", gradleconfig.GlobalActivateForGradleParams.TestDistro.Enabled, "Activate test distribution plugin for the provided app slug. Will override test-distribution-dep.")
+	activateForGradleCmd.Flags().BoolVar(&gradleconfig.GlobalActivateForGradleParams.TestDistro.JustDependency, "test-distribution-dep", gradleconfig.GlobalActivateForGradleParams.TestDistro.JustDependency, "Add test distribution plugin as a dependency only.")
+}
+
+func activateForGradleCmdFn(
+	logger log.Logger,
+	gradleHomePath string,
+	envProvider func(string) string,
+	templateInventoryProvider func(log.Logger, func(string) string, bool) (gradleconfig.TemplateInventory, error),
+	templateWriter func(gradleconfig.TemplateInventory, log.Logger, string, gradleconfig.OsProxy, gradleconfig.TemplateProxy) error,
+	updater gradleconfig.GradlePropertiesUpdater,
+) error {
+	templateInventory, err := templateInventoryProvider(logger, envProvider, isDebugLogMode)
+	if err != nil {
+		return err
+	}
+
+	if err := templateWriter(
+		templateInventory,
+		logger,
+		gradleHomePath,
+		gradleconfig.DefaultOsProxy(),
+		gradleconfig.DefaultTemplateProxy(),
+	); err != nil {
+		return err
+	}
+
+	if err := updater.UpdateGradleProps(gradleconfig.GlobalActivateForGradleParams, logger, gradleHomePath); err != nil {
+		return fmt.Errorf(errFmtFailedToUpdateProps, err)
+	}
+
+	return nil
+}

cmd/activate_for_gradle_cmd_test.go

@@ -0,0 +1,193 @@
+//nolint:dupl
+package cmd
+
+import (
+	"errors"
+	"fmt"
+	"os"
+	"testing"
+
+	gradleconfig "github.com/bitrise-io/bitrise-build-cache-cli/internal/config/gradle"
+	"github.com/bitrise-io/go-utils/v2/log"
+	"github.com/bitrise-io/go-utils/v2/mocks"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+)
+
+func Test_activateForGradleCmdFn(t *testing.T) {
+	prep := func() log.Logger {
+		mockLogger := &mocks.Logger{}
+		mockLogger.On("Infof", mock.Anything).Return()
+		mockLogger.On("Infof", mock.Anything, mock.Anything).Return()
+		mockLogger.On("Debugf", mock.Anything).Return()
+		mockLogger.On("Debugf", mock.Anything, mock.Anything).Return()
+		mockLogger.On("Errorf", mock.Anything).Return()
+		mockLogger.On("Errorf", mock.Anything, mock.Anything).Return()
+
+		return mockLogger
+	}
+
+	t.Run("activateForGradleCmdFn", func(t *testing.T) {
+		mockLogger := prep()
+		templateInventory := gradleconfig.TemplateInventory{
+			Common: gradleconfig.PluginCommonTemplateInventory{
+				AppSlug: "AppSlugValue",
+			},
+		}
+
+		var actualTemplateInventory *gradleconfig.TemplateInventory
+		var actualPath *string
+
+		// when
+		err := activateForGradleCmdFn(
+			mockLogger,
+			"~/.gradle",
+			func(string) string { return "" },
+			func(log.Logger, func(string) string, bool) (gradleconfig.TemplateInventory, error) {
+				return templateInventory, nil
+			},
+			func(
+				inventory gradleconfig.TemplateInventory,
+				_ log.Logger,
+				_ string,
+				_ gradleconfig.OsProxy,
+				_ gradleconfig.TemplateProxy,
+			) error {
+				actualTemplateInventory = &inventory
+
+				return nil
+			},
+			gradleconfig.GradlePropertiesUpdater{
+				OsProxy: gradleconfig.OsProxy{
+					ReadFileIfExists: func(pth string) (string, bool, error) {
+						actualPath = &pth
+
+						return "", true, nil
+					},
+					WriteFile: func(string, []byte, os.FileMode) error { return nil },
+				},
+			},
+		)
+
+		// then
+		require.NoError(t, err)
+		require.Equal(t, templateInventory, *actualTemplateInventory)
+		require.Equal(t, "~/.gradle/gradle.properties", *actualPath)
+	})
+
+	t.Run("when templateInventory creation fails activateForGradleCmdFn throws error", func(t *testing.T) {
+		mockLogger := prep()
+		inventoryCreationError := errors.New("failed to create inventory")
+
+		// when
+		err := activateForGradleCmdFn(
+			mockLogger,
+			"~/.gradle",
+			func(string) string { return "" },
+			func(log.Logger, func(string) string, bool) (gradleconfig.TemplateInventory, error) {
+				return gradleconfig.TemplateInventory{}, inventoryCreationError
+			},
+			func(
+				gradleconfig.TemplateInventory,
+				log.Logger,
+				string,
+				gradleconfig.OsProxy,
+				gradleconfig.TemplateProxy,
+			) error {
+				return nil
+			},
+			gradleconfig.GradlePropertiesUpdater{
+				OsProxy: gradleconfig.OsProxy{
+					ReadFileIfExists: func(string) (string, bool, error) {
+						return "", true, nil
+					},
+					WriteFile: func(string, []byte, os.FileMode) error { return nil },
+				},
+			},
+		)
+
+		// then
+		require.EqualError(t, err, inventoryCreationError.Error())
+	})
+
+	t.Run("when template writing fails activateForGradleCmdFn throws error", func(t *testing.T) {
+		mockLogger := prep()
+		templateWriteError := errors.New("failed to write template")
+
+		// when
+		err := activateForGradleCmdFn(
+			mockLogger,
+			"~/.gradle",
+			func(string) string { return "" },
+			func(log.Logger, func(string) string, bool) (gradleconfig.TemplateInventory, error) {
+				return gradleconfig.TemplateInventory{}, nil
+			},
+			func(
+				gradleconfig.TemplateInventory,
+				log.Logger,
+				string,
+				gradleconfig.OsProxy,
+				gradleconfig.TemplateProxy,
+			) error {
+				return templateWriteError
+			},
+			gradleconfig.GradlePropertiesUpdater{
+				OsProxy: gradleconfig.OsProxy{
+					ReadFileIfExists: func(string) (string, bool, error) {
+						return "", true, nil
+					},
+					WriteFile: func(string, []byte, os.FileMode) error { return nil },
+				},
+			},
+		)
+
+		// then
+		require.EqualError(t, err, templateWriteError.Error())
+	})
+
+	t.Run("when gradle.property update fails activateForGradleCmdFn throws error", func(t *testing.T) {
+		mockLogger := prep()
+		gradlePropertiesUpdateError := errors.New("failed to update gradle.properties")
+
+		// when
+		err := activateForGradleCmdFn(
+			mockLogger,
+			"~/.gradle",
+			func(string) string { return "" },
+			func(log.Logger, func(string) string, bool) (gradleconfig.TemplateInventory, error) {
+				return gradleconfig.TemplateInventory{}, nil
+			},
+			func(
+				gradleconfig.TemplateInventory,
+				log.Logger,
+				string,
+				gradleconfig.OsProxy,
+				gradleconfig.TemplateProxy,
+			) error {
+				return nil
+			},
+			gradleconfig.GradlePropertiesUpdater{
+				OsProxy: gradleconfig.OsProxy{
+					ReadFileIfExists: func(string) (string, bool, error) {
+						return "", true, nil
+					},
+					WriteFile: func(string, []byte, os.FileMode) error { return gradlePropertiesUpdateError },
+				},
+			},
+		)
+
+		// then
+		require.EqualError(
+			t,
+			err,
+			fmt.Errorf(
+				errFmtFailedToUpdateProps,
+				fmt.Errorf(
+					gradleconfig.ErrFmtGradlePropertyWrite,
+					"~/.gradle/gradle.properties",
+					gradlePropertiesUpdateError,
+				),
+			).Error(),
+		)
+	})
+}