feat: notation plugin uninstall command

cmd/notation/internal/errors/errors.go

@@ -50,3 +50,16 @@ type ErrorExceedMaxSignatures struct {
 func (e ErrorExceedMaxSignatures) Error() string {
 	return fmt.Sprintf("exceeded configured limit of max signatures %d to examine", e.MaxSignatures)
 }
+
+// ErrorInvalidPluginName is used when a plugin executable file name does not
+// follow the spec.
+type ErrorInvalidPluginName struct {
+	Msg string
+}
+
+func (e ErrorInvalidPluginName) Error() string {
+	if e.Msg != "" {
+		return e.Msg
+	}
+	return "invalid plugin file name"
+}

cmd/notation/internal/plugin/plugin.go

@@ -0,0 +1,32 @@
+// Copyright The Notary Project Authors.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License 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 plugin
+
+import (
+	"context"
+
+	"github.com/notaryproject/notation-go/dir"
+	"github.com/notaryproject/notation-go/plugin"
+	"github.com/notaryproject/notation-go/plugin/proto"
+)
+
+// GetPluginMetadataIfExist returns plugin's metadata if it exists in Notation
+func GetPluginMetadataIfExist(ctx context.Context, pluginName string) (*proto.GetMetadataResponse, error) {
+	mgr := plugin.NewCLIManager(dir.PluginFS())
+	plugin, err := mgr.Get(ctx, pluginName)
+	if err != nil {
+		return nil, err
+	}
+	return plugin.GetMetadata(ctx, &proto.GetMetadataRequest{})
+}

cmd/notation/internal/plugin/plugin_test.go

@@ -0,0 +1,28 @@
+// Copyright The Notary Project Authors.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License 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 plugin
+
+import (
+	"context"
+	"errors"
+	"os"
+	"testing"
+)
+
+func TestGetPluginMetadataIfExist(t *testing.T) {
+	_, err := GetPluginMetadataIfExist(context.Background(), "non-exist-plugin")
+	if !errors.Is(err, os.ErrNotExist) {
+		t.Fatalf("expected os.ErrNotExist err, got: %v", err)
+	}
+}

cmd/notation/main.go

@@ -17,6 +17,7 @@ import (
 	"os"
 
 	"github.com/notaryproject/notation/cmd/notation/cert"
+	"github.com/notaryproject/notation/cmd/notation/plugin"
 	"github.com/notaryproject/notation/cmd/notation/policy"
 	"github.com/spf13/cobra"
 )
@@ -40,7 +41,7 @@ func main() {
 		cert.Cmd(),
 		policy.Cmd(),
 		keyCommand(),
-		pluginCommand(),
+		plugin.Cmd(),
 		loginCommand(nil),
 		logoutCommand(nil),
 		versionCommand(),

cmd/notation/plugin/cmd.go

@@ -0,0 +1,30 @@
+// Copyright The Notary Project Authors.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License 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 plugin
+
+import "github.com/spf13/cobra"
+
+func Cmd() *cobra.Command {
+	command := &cobra.Command{
+		Use:   "plugin",
+		Short: "Manage plugins",
+	}
+
+	command.AddCommand(
+		pluginListCommand(),
+		pluginUninstallCommand(nil),
+	)
+
+	return command
+}

cmd/notation/plugin.go → cmd/notation/plugin/list.go

@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package main
+package plugin
 
 import (
 	"fmt"
@@ -24,15 +24,6 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func pluginCommand() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "plugin",
-		Short: "Manage plugins",
-	}
-	cmd.AddCommand(pluginListCommand())
-	return cmd
-}
-
 func pluginListCommand() *cobra.Command {
 	return &cobra.Command{
 		Use:     "list [flags]",

cmd/notation/plugin/uninstall.go

@@ -0,0 +1,96 @@
+// Copyright The Notary Project Authors.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License 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 plugin
+
+import (
+	"errors"
+	"fmt"
+	"os"
+
+	"github.com/notaryproject/notation-go/dir"
+	"github.com/notaryproject/notation/cmd/notation/internal/cmdutil"
+	notationplugin "github.com/notaryproject/notation/cmd/notation/internal/plugin"
+	"github.com/notaryproject/notation/internal/cmd"
+	"github.com/spf13/cobra"
+)
+
+type pluginUninstallOpts struct {
+	cmd.LoggingFlagOpts
+	pluginName string
+	confirmed  bool
+}
+
+func pluginUninstallCommand(opts *pluginUninstallOpts) *cobra.Command {
+	if opts == nil {
+		opts = &pluginUninstallOpts{}
+	}
+	command := &cobra.Command{
+		Use:     "uninstall [flags] <plugin_name>",
+		Aliases: []string{"remove", "rm"},
+		Short:   "Uninstall a plugin",
+		Long: `Uninstall a plugin
+
+Example - Uninstall plugin:
+  notation plugin uninstall wabbit-plugin
+`,
+		Args: func(cmd *cobra.Command, args []string) error {
+			if len(args) == 0 {
+				return errors.New("plugin name is required")
+			}
+			if len(args) > 1 {
+				return errors.New("can only remove one plugin at a time")
+			}
+			opts.pluginName = args[0]
+			return nil
+		},
+		RunE: func(cmd *cobra.Command, args []string) error {
+			return unInstallPlugin(cmd, opts)
+		},
+	}
+
+	opts.LoggingFlagOpts.ApplyFlags(command.Flags())
+	command.Flags().BoolVarP(&opts.confirmed, "yes", "y", false, "do not prompt for confirmation")
+	return command
+}
+
+func unInstallPlugin(command *cobra.Command, opts *pluginUninstallOpts) error {
+	// set log level
+	ctx := opts.LoggingFlagOpts.InitializeLogger(command.Context())
+	pluginName := opts.pluginName
+	_, err := notationplugin.GetPluginMetadataIfExist(ctx, pluginName)
+	if err != nil {
+		if errors.Is(err, os.ErrNotExist) { // plugin does not exist
+			return fmt.Errorf("unable to find plugin %s.\nTo view a list of installed plugins, use `notation plugin list`", pluginName)
+		}
+		return fmt.Errorf("failed to uninstall %s: %w", pluginName, err)
+	}
+	// core process
+	pluginPath, err := dir.PluginFS().SysPath(pluginName)
+	if err != nil {
+		return fmt.Errorf("failed to uninstall %s: %v", pluginName, err)
+	}
+	prompt := fmt.Sprintf("Are you sure you want to uninstall plugin %q?", pluginName)
+	confirmed, err := cmdutil.AskForConfirmation(os.Stdin, prompt, opts.confirmed)
+	if err != nil {
+		return fmt.Errorf("failed to uninstall %s: %v", pluginName, err)
+	}
+	if !confirmed {
+		return nil
+	}
+	if err := os.RemoveAll(pluginPath); err != nil {
+		return fmt.Errorf("failed to uninstall %s: %v", pluginName, err)
+	}
+	fmt.Printf("Successfully uninstalled plugin %s\n", pluginName)
+	return nil
+}

internal/osutil/file.go

@@ -72,8 +72,8 @@ func CopyToDir(src, dst string) (int64, error) {
 	if err := os.MkdirAll(dst, 0700); err != nil {
 		return 0, err
 	}
-	certFile := filepath.Join(dst, filepath.Base(src))
-	destination, err := os.Create(certFile)
+	dstFile := filepath.Join(dst, filepath.Base(src))
+	destination, err := os.Create(dstFile)
 	if err != nil {
 		return 0, err
 	}

test/e2e/internal/notation/init.go

@@ -33,30 +33,32 @@ const (
 )
 
 const (
-	envKeyRegistryHost       = "NOTATION_E2E_REGISTRY_HOST"
-	envKeyRegistryUsername   = "NOTATION_E2E_REGISTRY_USERNAME"
-	envKeyRegistryPassword   = "NOTATION_E2E_REGISTRY_PASSWORD"
-	envKeyDomainRegistryHost = "NOTATION_E2E_DOMAIN_REGISTRY_HOST"
-	envKeyNotationBinPath    = "NOTATION_E2E_BINARY_PATH"
-	envKeyNotationOldBinPath = "NOTATION_E2E_OLD_BINARY_PATH"
-	envKeyNotationPluginPath = "NOTATION_E2E_PLUGIN_PATH"
-	envKeyNotationConfigPath = "NOTATION_E2E_CONFIG_PATH"
-	envKeyOCILayoutPath      = "NOTATION_E2E_OCI_LAYOUT_PATH"
-	envKeyTestRepo           = "NOTATION_E2E_TEST_REPO"
-	envKeyTestTag            = "NOTATION_E2E_TEST_TAG"
+	envKeyRegistryHost            = "NOTATION_E2E_REGISTRY_HOST"
+	envKeyRegistryUsername        = "NOTATION_E2E_REGISTRY_USERNAME"
+	envKeyRegistryPassword        = "NOTATION_E2E_REGISTRY_PASSWORD"
+	envKeyDomainRegistryHost      = "NOTATION_E2E_DOMAIN_REGISTRY_HOST"
+	envKeyNotationBinPath         = "NOTATION_E2E_BINARY_PATH"
+	envKeyNotationOldBinPath      = "NOTATION_E2E_OLD_BINARY_PATH"
+	envKeyNotationPluginPath      = "NOTATION_E2E_PLUGIN_PATH"
+	envKeyNotationPluginTarGzPath = "NOTATION_E2E_PLUGIN_TAR_GZ_PATH"
+	envKeyNotationConfigPath      = "NOTATION_E2E_CONFIG_PATH"
+	envKeyOCILayoutPath           = "NOTATION_E2E_OCI_LAYOUT_PATH"
+	envKeyTestRepo                = "NOTATION_E2E_TEST_REPO"
+	envKeyTestTag                 = "NOTATION_E2E_TEST_TAG"
 )
 
 var (
 	// NotationBinPath is the notation binary path.
 	NotationBinPath string
 	// NotationOldBinPath is the path of an old version notation binary for
 	// testing forward compatibility.
-	NotationOldBinPath        string
-	NotationE2EPluginPath     string
-	NotationE2EConfigPath     string
-	NotationE2ELocalKeysDir   string
-	NotationE2ETrustPolicyDir string
-	NotationE2EConfigJsonDir  string
+	NotationOldBinPath         string
+	NotationE2EPluginPath      string
+	NotationE2EPluginTarGzPath string
+	NotationE2EConfigPath      string
+	NotationE2ELocalKeysDir    string
+	NotationE2ETrustPolicyDir  string
+	NotationE2EConfigJsonDir   string
 )
 
 var (
@@ -90,6 +92,7 @@ func setUpNotationValues() {
 
 	// set Notation e2e-plugin path
 	setPathValue(envKeyNotationPluginPath, &NotationE2EPluginPath)
+	setPathValue(envKeyNotationPluginTarGzPath, &NotationE2EPluginTarGzPath)
 
 	// set Notation configuration paths
 	setPathValue(envKeyNotationConfigPath, &NotationE2EConfigPath)

test/e2e/run.sh

@@ -71,9 +71,9 @@ fi
 # install dependency
 go install -mod=mod github.com/onsi/ginkgo/v2/[email protected]
 
-# build e2e plugin
+# build e2e plugin and tar.gz
 PLUGIN_NAME=e2e-plugin
-( cd $CWD/plugin && go build -o ./bin/$PLUGIN_NAME . && echo "e2e plugin built." )
+( cd $CWD/plugin && go build -o ./bin/$PLUGIN_NAME . && echo "e2e plugin built." && tar --transform="flags=r;s|$PLUGIN_NAME|notation-$PLUGIN_NAME|" -czvf ./bin/$PLUGIN_NAME.tar.gz -C ./bin/ $PLUGIN_NAME)
 
 # setup registry
 case $REGISTRY_NAME in
@@ -107,6 +107,7 @@ export NOTATION_E2E_OCI_LAYOUT_PATH=$CWD/testdata/registry/oci_layout
 export NOTATION_E2E_TEST_REPO=e2e
 export NOTATION_E2E_TEST_TAG=v1
 export NOTATION_E2E_PLUGIN_PATH=$CWD/plugin/bin/$PLUGIN_NAME
+export NOTATION_E2E_PLUGIN_TAR_GZ_PATH=$CWD/plugin/bin/$PLUGIN_NAME.tar.gz
 
 # run tests
 ginkgo -r -p -v

test/e2e/suite/plugin/uninstall.go

@@ -0,0 +1,38 @@
+// Copyright The Notary Project Authors.
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License 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 plugin
+
+import (
+	. "github.com/notaryproject/notation/test/e2e/internal/notation"
+	"github.com/notaryproject/notation/test/e2e/internal/utils"
+	. "github.com/onsi/ginkgo/v2"
+)
+
+var _ = Describe("notation plugin uninstall", func() {
+	It("with valid plugin name", func() {
+		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
+			vhost.SetOption(AddPlugin(NotationE2EPluginPath))
+			notation.Exec("plugin", "uninstall", "--yes", "e2e-plugin").
+				MatchContent("Successfully uninstalled plugin e2e-plugin\n")
+		})
+	})
+
+	It("with plugin does not exist", func() {
+		Host(nil, func(notation *utils.ExecOpts, _ *Artifact, vhost *utils.VirtualHost) {
+			notation.ExpectFailure().Exec("plugin", "uninstall", "--yes", "non-exist").
+				MatchErrContent("Error: unable to find plugin non-exist.\nTo view a list of installed plugins, use `notation plugin list`\n")
+		})
+	})
+
+})