feat: apply extension command (#205)

Author: fredmaggiowski

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - `extensions list` command
+- `extensions apply` command
 - `extensions delete` command
 - `extensions activate` command
 - `extensions deactivate` command

docs/30_commands.md

@@ -556,6 +556,175 @@ Available flags for the command:
 - `--no-semver`, to force the deploy without `semver`
 - `--revision`, to specify the revision of the commit to deploy
 
+## extensions
+
+The `extensions` command allows you to manage Company extensions.
+
+Available subcommands are the following ones:
+
+```sh
+  list        List registered extensions
+  apply       Create or update an extension
+  activate    Activate an extension
+  deactivate  Deactivate an extension
+  delete      Delete extension
+```
+
+### list
+
+The `extensions list` command helps you gathering available extension in your Company
+
+Usage:
+
+```sh
+miactl extensions list [flags]
+```
+
+Available flags for the command:
+
+- `--company-id` to set the ID of the desired Company
+
+### apply
+
+The `extensions apply` command can be used to register new extensions or update an existing one.
+
+It accepts an Extension Manifest either in `yaml` or `json` format
+
+<details>
+<summary>Example JSON Manifest<summary>
+
+```json
+{
+    "name": "Extension 1",
+    "description": "My extension 1",
+    "entry": "https://example.com/",
+    "contexts": [
+        "project"
+    ],
+    "routes": [
+        {
+            "id": "extension-1",
+            "parentId": "workloads",
+            "locationId": "runtime",
+            "renderType": "menu",
+            "labelIntl": {
+                "en": "SomeLabel",
+                "it": "SomeLabelInItalian"
+            },
+            "destinationPath": "/",
+            "order": 200.0,
+            "icon": {
+                "name": "PiHardDrives"
+            }
+        }
+    ]
+}
+```
+
+</details>
+
+<details>
+<summary>Example YAML Manifest<summary>
+
+```yaml
+name: "Extension 1"
+description: "My extension 1"
+entry: "https://example.com/"
+contexts:
+  - project
+routes:
+  - id: "extension-1"
+    parentId: "workloads"
+    locationId: "runtime"
+    labelIntl:
+      en: "SomeLabel"
+      it: "SomeLabelInItalian"
+    destinationPath: "/"
+    renderType: "menu"
+    order: 200
+    icon:
+      name: "PiHardDrives"
+```
+
+</details>
+
+Usage:
+
+```sh
+miactl extensions apply [flags]
+```
+
+Available flags for the command:
+
+- `--company-id` to set the ID of the desired Company
+- `--file-path` (`-f`) **required** to specify the path to the extension manifest
+- `--extension-id` to set the ID of the extension Company, required for updating an existing extension.
+
+:::tip
+In order to specify whether a create or an update is needed you have to use the `--extension-id` 
+flag or specify the `extensionId` property in the manifest file.
+
+You can get the **extension id** by using the [extensions list](#list-5) command or
+in the apply response after creating the extension.
+:::
+
+### activate
+
+The `extensions activate` command can be used to delete an existing extension.
+
+:::tip
+You can activate an extension on the whole Company or only for specific Projects.
+If you activate it for the whole Company it will be inherited by all the Projects
+:::
+
+Usage:
+
+```sh
+miactl extensions activate [flags]
+```
+
+Available flags for the command:
+
+- `--company-id` to set the ID of the desired Company
+- `--project-id` to set the ID of the desired project, if specified, the extension will be activated only for this project only
+- `--extension-id` **required** to set the ID of the extension.
+
+### deactivate
+
+The `extensions deactivate` command can be used to delete an existing extension.
+
+:::tip
+Please note that if an extension has been activated on the whole Company it can't be deactivated on a specific Project;
+you have to deactivate on the whole Company and activate it on the desired Projects.
+:::
+
+Usage:
+
+```sh
+miactl extensions deactivate [flags]
+```
+
+Available flags for the command:
+
+- `--company-id` to set the ID of the desired Company
+- `--project-id` to set the ID of the desired project, if specified, the extension will be deactivated only for this project only
+- `--extension-id` **required** to set the ID of the extension.
+
+### delete
+
+The `extensions delete` command can be used to delete an existing extension.
+
+Usage:
+
+```sh
+miactl extensions delete [flags]
+```
+
+Available flags for the command:
+
+- `--company-id` to set the ID of the desired Company
+- `--extension-id` **required** to set the ID of the extension, required for updating an existing extension.
+
 ## runtime
 
 ### environment list
@@ -691,7 +860,7 @@ View and manage Marketplace items
 
 All the subcommands inherit the following flags:
 
-```
+```sh
       --auth-name string               the name of the miactl auth to use
       --certificate-authority string   path to a cert file for the certificate authority for the selected endpoint
       --company-id string              the ID of the Company

internal/client/client.go

@@ -74,6 +74,11 @@ func (c *APIClient) Post() *Request {
 	return NewRequest(c).SetVerb(http.MethodPost)
 }
 
+// Put return a new Request object for a Put http request
+func (c *APIClient) Put() *Request {
+	return NewRequest(c).SetVerb(http.MethodPut)
+}
+
 // Delete return a new Request object for a DELETE http request
 func (c *APIClient) Delete() *Request {
 	return NewRequest(c).SetVerb(http.MethodDelete)

internal/client/request.go

@@ -151,6 +151,8 @@ func (r *Request) preflightCheck() error {
 	}
 
 	switch {
+	case r.verb == http.MethodPut && len(r.body) == 0:
+		fallthrough
 	case r.verb == http.MethodPost && len(r.body) == 0:
 		return fmt.Errorf("empty body for a POST request")
 	case r.verb == http.MethodGet && len(r.body) > 0:

internal/client/request_test.go

@@ -125,6 +125,9 @@ func TestPreflightCheck(t *testing.T) {
 		"correct POST": {
 			request: (&Request{}).SetVerb("POST").Body([]byte("hello")),
 		},
+		"correct PUT": {
+			request: (&Request{}).SetVerb("PUT").Body([]byte("hello")),
+		},
 		"empty verb": {
 			request: &Request{},
 			err:     true,
@@ -137,6 +140,10 @@ func TestPreflightCheck(t *testing.T) {
 			request: (&Request{}).SetVerb("POST").Body([]byte{}),
 			err:     true,
 		},
+		"empty body for PUT": {
+			request: (&Request{}).SetVerb("PUT").Body([]byte{}),
+			err:     true,
+		},
 		"valid verb and body but preexisting error": {
 			request: (&Request{err: fmt.Errorf("")}).SetVerb("GET"),
 			err:     true,

internal/clioptions/clioptions.go

@@ -64,6 +64,8 @@ type CLIOptions struct {
 	JWTJsonPath       string
 	OutputPath        string
 
+	InputFilePath string
+
 	MarketplaceResourcePaths []string
 	// MarketplaceItemID is the itemId field of a Marketplace item
 	MarketplaceItemID string

internal/cmd/extensions/activate.go

@@ -56,6 +56,6 @@ context to select where you want to activate it.`,
 		},
 	}
 
-	addExtensionIDRequiredFlag(o, cmd)
+	addExtensionIDFlag(o, cmd)
 	return cmd
 }

internal/cmd/extensions/apply.go

@@ -0,0 +1,88 @@
+// Copyright Mia srl
+// SPDX-License-Identifier: Apache-2.0
+//
+// 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 extensions
+
+import (
+	"fmt"
+
+	"github.com/mia-platform/miactl/internal/client"
+	"github.com/mia-platform/miactl/internal/clioptions"
+	"github.com/mia-platform/miactl/internal/files"
+	"github.com/mia-platform/miactl/internal/resources/extensibility"
+
+	"github.com/spf13/cobra"
+)
+
+func ApplyCmd(o *clioptions.CLIOptions) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "apply",
+		Short: "Create or update an extension",
+		Long: `Use this command to create a new extension or to update an existing one.
+
+Extension data must be provided with a file, submitted with the -f flag; you can specificy the
+extension-id either within the manifest file or via command line argument.
+
+If an extension-id is found an updated is performed, if not instead a new extension will be created.`,
+		RunE: func(cmd *cobra.Command, _ []string) error {
+			restConfig, err := o.ToRESTConfig()
+			cobra.CheckErr(err)
+
+			client, err := client.APIClientForConfig(restConfig)
+			cobra.CheckErr(err)
+
+			if restConfig.CompanyID == "" {
+				return ErrRequiredCompanyID
+			}
+
+			extensionData, err := readExtensionFromFile(o.InputFilePath)
+			if err != nil {
+				return err
+			}
+
+			if o.EntityID != "" && extensionData.ExtensionID != "" && o.EntityID != extensionData.ExtensionID {
+				return fmt.Errorf("extension id has been provided both with flags and manifest and they mismatch")
+			}
+
+			if o.EntityID != "" {
+				extensionData.ExtensionID = o.EntityID
+			}
+
+			if extensionData.ExtensionType == "" {
+				extensionData.ExtensionType = IFrameExtensionType
+			}
+
+			extensibilityClient := New(client)
+			extensionID, err := extensibilityClient.Apply(cmd.Context(), restConfig.CompanyID, extensionData)
+			cobra.CheckErr(err)
+			fmt.Printf("Successfully applied extension with id %s\n", extensionID)
+			return nil
+		},
+	}
+
+	addExtensionIDFlag(o, cmd)
+	requireFilePathFlag(o, cmd)
+
+	return cmd
+}
+
+func readExtensionFromFile(path string) (*extensibility.Extension, error) {
+	extensionData := &extensibility.Extension{}
+	if err := files.ReadFile(path, extensionData); err != nil {
+		return nil, err
+	}
+
+	return extensionData, nil
+}