CLI to operate archives managed by Storage Service (#2450)

* Add API for listing storage service archives
If id is mentioned we allow user to download specific
archive. If id is not mentioned we list all archives
present with storage service.
This will allow us to build CLI with storage service
and help users to debug storage service.
* Added commands for storagesvc cli and functionalities
* Reusing code and added geturl and download.
* Fixed geturl for localstorage.
* Fixed description of fission archive command
* Added unit tests for function getstorageurl
* Added integration test for archive cli




Co-authored-by: Sanket Sudake <sanketsudake@gmail.com>

pkg/fission-cli/cmd/archive/command.go

@@ -0,0 +1,85 @@
+/*
+Copyright 2022 The Fission 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 archive
+
+import (
+	"github.com/spf13/cobra"
+
+	wrapper "github.com/fission/fission/pkg/fission-cli/cliwrapper/driver/cobra"
+	"github.com/fission/fission/pkg/fission-cli/flag"
+)
+
+func Commands() *cobra.Command {
+
+	uploadCmd := &cobra.Command{
+		Use:   "upload",
+		Short: "Upload an archive",
+		RunE:  wrapper.Wrapper(Upload),
+	}
+	wrapper.SetFlags(uploadCmd, flag.FlagSet{
+		Required: []flag.Flag{flag.ArchiveName},
+		Optional: []flag.Flag{flag.KubeContext},
+	})
+
+	listCmd := &cobra.Command{
+		Use:   "list",
+		Short: "List all uploaded archives",
+		RunE:  wrapper.Wrapper(List),
+	}
+	wrapper.SetFlags(listCmd, flag.FlagSet{
+		Optional: []flag.Flag{flag.KubeContext},
+	})
+
+	deleteCmd := &cobra.Command{
+		Use:   "delete",
+		Short: "Delete an archive",
+		RunE:  wrapper.Wrapper(Delete),
+	}
+	wrapper.SetFlags(deleteCmd, flag.FlagSet{
+		Required: []flag.Flag{flag.ArchiveID},
+		Optional: []flag.Flag{flag.ArchiveOutput},
+	})
+
+	geturlCmd := &cobra.Command{
+		Use:   "get-url",
+		Short: "Get URL of an uploaded archive",
+		RunE:  wrapper.Wrapper(GetURL),
+	}
+	wrapper.SetFlags(geturlCmd, flag.FlagSet{
+		Required: []flag.Flag{flag.ArchiveID},
+		Optional: []flag.Flag{flag.KubeContext},
+	})
+
+	downloadCmd := &cobra.Command{
+		Use:   "download",
+		Short: "Download an archive",
+		RunE:  wrapper.Wrapper(Download),
+	}
+	wrapper.SetFlags(downloadCmd, flag.FlagSet{
+		Required: []flag.Flag{flag.ArchiveID},
+		Optional: []flag.Flag{flag.KubeContext, flag.ArchiveOutput},
+	})
+
+	command := &cobra.Command{
+		Use:     "archive",
+		Short:   "Manage archives stored with Fission Storage Service.",
+		Aliases: []string{"ar"},
+	}
+
+	command.AddCommand(uploadCmd, listCmd, deleteCmd, geturlCmd, downloadCmd)
+	return command
+}

pkg/fission-cli/cmd/archive/delete.go

@@ -0,0 +1,58 @@
+/*
+Copyright 2022 The Fission 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 archive
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	flagkey "github.com/fission/fission/pkg/fission-cli/flag/key"
+	"github.com/fission/fission/pkg/fission-cli/util"
+	storagesvcClient "github.com/fission/fission/pkg/storagesvc/client"
+)
+
+type DeleteSubCommand struct {
+	cmd.CommandActioner
+}
+
+func Delete(input cli.Input) error {
+	return (&DeleteSubCommand{}).do(input)
+}
+
+func (opts *DeleteSubCommand) do(input cli.Input) error {
+
+	kubeContext := input.String(flagkey.KubeContext)
+	archiveID := input.String(flagkey.ArchiveID)
+
+	storagesvcURL, err := util.GetStorageURL(kubeContext)
+	if err != nil {
+		return err
+	}
+
+	client := storagesvcClient.MakeClient(storagesvcURL.String())
+
+	err = client.Delete(context.Background(), archiveID)
+	if err != nil {
+		return err
+	}
+
+	fmt.Printf("Deleted archive with id: %s", archiveID)
+
+	return nil
+}

pkg/fission-cli/cmd/archive/download.go

@@ -0,0 +1,62 @@
+/*
+Copyright 2022 The Fission 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 archive
+
+import (
+	"context"
+	"fmt"
+	"strings"
+
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	flagkey "github.com/fission/fission/pkg/fission-cli/flag/key"
+	"github.com/fission/fission/pkg/fission-cli/util"
+	storagesvcClient "github.com/fission/fission/pkg/storagesvc/client"
+)
+
+type DownloadSubCommand struct {
+	cmd.CommandActioner
+}
+
+func Download(input cli.Input) error {
+	return (&DownloadSubCommand{}).do(input)
+}
+
+func (opts *DownloadSubCommand) do(input cli.Input) error {
+
+	kubeContext := input.String(flagkey.KubeContext)
+	archiveID := input.String(flagkey.ArchiveID)
+	archiveOutput := input.String(flagkey.ArchiveOutput)
+
+	if len(archiveOutput) == 0 {
+		archiveOutput = strings.TrimPrefix(archiveID, "/fission/fission-functions/")
+	}
+
+	storageAccessURL, err := util.GetStorageURL(kubeContext)
+	if err != nil {
+		return err
+	}
+
+	client := storagesvcClient.MakeClient(storageAccessURL.String())
+	err = client.Download(context.Background(), archiveID, archiveOutput)
+	if err != nil {
+		return err
+	}
+
+	fmt.Printf("File download complete. File name: %s", archiveOutput)
+	return nil
+}

pkg/fission-cli/cmd/archive/geturl.go

@@ -0,0 +1,85 @@
+/*
+Copyright 2019 The Fission 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 archive
+
+import (
+	"fmt"
+	"net/http"
+	"net/url"
+
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	flagkey "github.com/fission/fission/pkg/fission-cli/flag/key"
+	"github.com/fission/fission/pkg/fission-cli/util"
+	storagesvcClient "github.com/fission/fission/pkg/storagesvc/client"
+)
+
+type GetURLSubCommand struct {
+	cmd.CommandActioner
+}
+
+func GetURL(input cli.Input) error {
+	return (&GetURLSubCommand{}).do(input)
+}
+
+func (opts *GetURLSubCommand) do(input cli.Input) error {
+
+	kubeContext := input.String(flagkey.KubeContext)
+	archiveID := input.String(flagkey.ArchiveID)
+
+	serverURL, err := util.GetStorageURL(kubeContext)
+	if err != nil {
+		return err
+	}
+
+	relativeURL, _ := url.Parse(util.FISSION_STORAGE_URI)
+
+	queryString := relativeURL.Query()
+	queryString.Set("id", archiveID)
+	relativeURL.RawQuery = queryString.Encode()
+
+	storageAccessURL := serverURL.ResolveReference(relativeURL)
+
+	resp, err := http.Head(storageAccessURL.String())
+	if err != nil {
+		return err
+	}
+	defer resp.Body.Close()
+
+	if resp.StatusCode != http.StatusOK {
+		return fmt.Errorf("Error getting URL. Exited with Status:  %v", resp.Status)
+	}
+
+	archiveURL, err := url.Parse(resp.Header.Get("X-FISSION-ARCHIVEURL"))
+	if err != nil {
+		return err
+	}
+
+	if archiveURL.Scheme == "file" {
+		storageSvc, err := opts.Client().V1().Misc().GetSvcURL("application=fission-storage")
+		if err != nil {
+			return err
+		}
+		storagesvcURL := "http://" + storageSvc
+		client := storagesvcClient.MakeClient(storagesvcURL)
+		fmt.Printf("URL: %s", client.GetUrl(archiveID))
+	} else {
+		fmt.Printf("URL: %s", archiveURL.String())
+	}
+
+	return nil
+}

pkg/fission-cli/cmd/archive/list.go

@@ -0,0 +1,60 @@
+/*
+Copyright 2022 The Fission 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 archive
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	flagkey "github.com/fission/fission/pkg/fission-cli/flag/key"
+	"github.com/fission/fission/pkg/fission-cli/util"
+	storagesvcClient "github.com/fission/fission/pkg/storagesvc/client"
+)
+
+type ListSubCommand struct {
+	cmd.CommandActioner
+}
+
+func List(input cli.Input) error {
+	return (&ListSubCommand{}).do(input)
+}
+
+func (opts *ListSubCommand) do(input cli.Input) error {
+
+	kubeContext := input.String(flagkey.KubeContext)
+
+	storageAccessURL, err := util.GetStorageURL(kubeContext)
+	if err != nil {
+		return err
+	}
+
+	client := storagesvcClient.MakeClient(storageAccessURL.String())
+	files, err := client.List(context.Background())
+	if err != nil {
+		return err
+	}
+
+	fmt.Println("ARCHIVES")
+	for _, file := range files {
+		fmt.Println(file)
+	}
+
+	return nil
+
+}

pkg/fission-cli/cmd/archive/upload.go

@@ -0,0 +1,57 @@
+/*
+Copyright 2022 The Fission 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 archive
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
+	"github.com/fission/fission/pkg/fission-cli/cmd"
+	flagkey "github.com/fission/fission/pkg/fission-cli/flag/key"
+	"github.com/fission/fission/pkg/fission-cli/util"
+	storagesvcClient "github.com/fission/fission/pkg/storagesvc/client"
+)
+
+type UploadSubCommand struct {
+	cmd.CommandActioner
+}
+
+func Upload(input cli.Input) error {
+	return (&UploadSubCommand{}).do(input)
+}
+
+func (opts *UploadSubCommand) do(input cli.Input) error {
+
+	kubeContext := input.String(flagkey.KubeContext)
+	archiveName := input.String(flagkey.ArchiveName)
+
+	storagesvcURL, err := util.GetStorageURL(kubeContext)
+	if err != nil {
+		return err
+	}
+
+	client := storagesvcClient.MakeClient(storagesvcURL.String())
+	archiveID, err := client.Upload(context.Background(), archiveName, nil)
+	if err != nil {
+		return err
+	}
+
+	fmt.Printf("File successfully uploaded with ID: %s ", archiveID)
+
+	return nil
+}

pkg/fission-cli/flag/flag.go

@@ -227,4 +227,8 @@ var (
 	CanaryWeightIncrement   = Flag{Type: Int, Name: flagkey.CanaryWeightIncrement, Aliases: []string{"step"}, Usage: "Weight increment step for function", DefaultValue: 20}
 	CanaryIncrementInterval = Flag{Type: String, Name: flagkey.CanaryIncrementInterval, Aliases: []string{"internal"}, Usage: "Weight increment interval, string representation of time.Duration, ex : 1m, 2h, 2d", DefaultValue: "2m"}
 	CanaryFailureThreshold  = Flag{Type: Int, Name: flagkey.CanaryFailureThreshold, Aliases: []string{"threshold"}, Usage: "Threshold in percentage beyond which the new version of the function is considered unstable", DefaultValue: 10}
+
+	ArchiveName   = Flag{Type: String, Name: flagkey.ArchiveName, Usage: "Name of the archive file"}
+	ArchiveID     = Flag{Type: String, Name: flagkey.ArchiveID, Usage: "Id for the archive file"}
+	ArchiveOutput = Flag{Type: String, Name: flagkey.ArchiveOutput, Usage: "Download file with this name", Aliases: []string{"o"}, DefaultValue: ""}
 )

pkg/fission-cli/flag/key/key.go

@@ -178,5 +178,9 @@ const (
 	CanaryIncrementInterval = "increment-interval"
 	CanaryFailureThreshold  = "failure-threshold"
 
+	ArchiveName   = resourceName
+	ArchiveID     = "id"
+	ArchiveOutput = Output
+
 	DefaultSpecOutputDir = "fission-dump"
 )

pkg/fission-cli/util/constants.go

@@ -18,8 +18,9 @@ package util
 
 // fission-cli options
 const (
-	SPEC_IGNORE_FILE   = ".specignore"
-	COMMIT_LABEL       = "commit"
-	FISSION_AUTH_URI   = "/auth/login"
-	FISSION_AUTH_TOKEN = "FISSION_AUTH_TOKEN"
+	SPEC_IGNORE_FILE    = ".specignore"
+	COMMIT_LABEL        = "commit"
+	FISSION_AUTH_URI    = "/auth/login"
+	FISSION_AUTH_TOKEN  = "FISSION_AUTH_TOKEN"
+	FISSION_STORAGE_URI = "/v1/archive"
 )

pkg/fission-cli/util/util.go

@@ -18,6 +18,7 @@ package util
 
 import (
 	"fmt"
+	"net/url"
 	"os"
 	"os/user"
 	"path/filepath"
@@ -443,3 +444,17 @@ func ApplyLabelsAndAnnotations(input cli.Input, objectMeta *metav1.ObjectMeta) e
 	}
 	return nil
 }
+
+func GetStorageURL(kubeContext string) (*url.URL, error) {
+	storageLocalPort, err := SetupPortForward(GetFissionNamespace(), "application=fission-storage", kubeContext)
+	if err != nil {
+		return nil, err
+	}
+
+	serverURL, err := url.Parse("http://127.0.0.1:" + storageLocalPort)
+	if err != nil {
+		return nil, err
+	}
+
+	return serverURL, nil
+}