Making sure to mount .smithy directory for sharing

findings;
running images on platforms that are not linux/amd64;
move main to root to fix go install issues.

Author: andream16

smithyctl/internal/command/component/testdata/package/valid/component.yaml

@@ -1,36 +1,20 @@
-name: example-component
-description: "This is an example component that demonstrates its functionality."
-type: target
+name: "git-clone"
+description: "Clones a repository"
+type: "target"
 parameters:
-  - name: input-path
-    type: string
-    value: "/data/input"
-  - name: max-retries
-    type: const:string
-    value: "3"
-  - name: allowed-users
-    type: list:string
-    value:
-      - user1
-      - user2
-      - user3
+  - name: "git_clone_repo_url"
+    type: "string"
+    value: "https://github.com/0c34/govwa.git"
+  - name: "git_clone_reference"
+    type: "string"
+    value: "master"
+  - name: "git_clone_magic_arg"
+    type: "const:string"
+    value: "-a 1 -b 2 -c 3"
 steps:
-  - name: fetch-data
-    args:
-      - "--source=/data/source"
-      - "--destination=/data/destination"
+  - name: "clone-repo"
     env_vars:
-      API_KEY: "your-api-key"
-      DEBUG: "true"
-    executable: "/usr/local/bin/fetcher"
-    image: "example/fetcher:latest"
-    script: ""
-  - name: process-data
-    args:
-      - "--input=/data/destination"
-      - "--output=/data/processed"
-    env_vars:
-      THREADS: "4"
-    executable: "/usr/local/bin/processor"
-    image: "example/processor:latest"
-    script: ""
+      GIT_CLONE_REPO_URL: "{{ parameters.git_clone_repo_url }}"
+      GIT_CLONE_REFERENCE: "{{ parameters.git_clone_reference }}"
+      GIT_CLONE_MAGIC_ARG: "{{- with shlex parameters.git_clone_magic_arg -}}"
+    image: "localhost:5000/components/targets/git-clone:latest"

smithyctl/internal/engine/docker/client.go

@@ -24,10 +24,10 @@ type executor struct {
 // NewExecutor returns a new docker executor.
 func NewExecutor(cli *client.Client) (*executor, error) {
 	// // Using available docker setup.
-	// cli, err := client.NewClientWithOpts(client.FromEnv)
-	// if err != nil {
-	// 	return nil, errors.Errorf("failed to create docker client: %w", err)
-	// }
+	cli, err := client.NewClientWithOpts(client.FromEnv, client.WithAPIVersionNegotiation())
+	if err != nil {
+		return nil, errors.Errorf("failed to create docker client: %w", err)
+	}
 	return &executor{dockerClient: cli}, nil
 }
 

smithyctl/internal/engine/engine.go

@@ -8,6 +8,7 @@ import (
 	"maps"
 	"os"
 	"path"
+	"path/filepath"
 	"slices"
 	"text/template"
 
@@ -246,7 +247,15 @@ func (e *executor) executeStep(
 		return errors.Errorf("%s: could not render step: %w", step.Name, err)
 	}
 
-	volumeBindings := []string{}
+	absPath, err := filepath.Abs(".")
+	if err != nil {
+		return errors.Errorf("failed to determine absolute path: %w", err)
+	}
+
+	volumeBindings := []string{
+		path.Join(absPath, fmt.Sprintf("%s:/workspace", smithyDir)),
+	}
+
 	for _, stepVolume := range stepVolumes {
 		volumeBindings = append(volumeBindings, stepVolume.hostPath+":"+stepVolume.mountPath)
 	}
@@ -274,11 +283,6 @@ func (e *executor) executeStep(
 			Cmd:            step.Args,
 			EnvVars:        envVars,
 			VolumeBindings: volumeBindings,
-			// Standardising the platform to avoid not fun issues on different OS/ARCH.
-			Platform: &ocispec.Platform{
-				Architecture: "amd64",
-				OS:           "linux",
-			},
 		},
 	); err != nil {
 		return errors.Errorf("failed to execute step '%s': %w", step.Name, err)

smithyctl/internal/engine/engine_test.go

@@ -3,11 +3,12 @@ package engine_test
 import (
 	"context"
 	"fmt"
+	"path"
+	"path/filepath"
 	"slices"
 	"testing"
 	"time"
 
-	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/mock/gomock"
 
@@ -64,6 +65,9 @@ func TestExecutor_Execute(t *testing.T) {
 	instanceID, err := uuid.Parse("37087cc2-e4ba-4fe0-8230-cda372778ed7")
 	require.NoError(t, err)
 
+	absPath, err := filepath.Abs(".")
+	require.NoError(t, err)
+
 	var (
 		ctx, cancel = context.WithTimeout(context.Background(), time.Second)
 		ctrl        = gomock.NewController(t)
@@ -220,16 +224,10 @@ func TestExecutor_Execute(t *testing.T) {
 	require.NoError(t, err)
 	require.NotNil(t, exe)
 
-	var (
-		envVars = []string{
-			fmt.Sprintf("SMITHY_INSTANCE_ID=%s", instanceID.String()),
-			"SMITHY_LOG_LEVEL=debug",
-		}
-		platform = &ocispec.Platform{
-			Architecture: "amd64",
-			OS:           "linux",
-		}
-	)
+	var envVars = []string{
+		fmt.Sprintf("SMITHY_INSTANCE_ID=%s", instanceID.String()),
+		"SMITHY_LOG_LEVEL=debug",
+	}
 
 	t.Run("it executes a workflow correctly", func(t *testing.T) {
 		gomock.InOrder(
@@ -243,10 +241,10 @@ func TestExecutor_Execute(t *testing.T) {
 						Executable: "/bin/clone",
 						EnvVars:    appendAndSort(envVars, "REPO_URL=github.com/andream16/tree"),
 						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
 							sourceCodeHostPath + ":" + sourceCodeMountPath,
 						},
-						Cmd:      []string{"/workspace/source-code"},
-						Platform: platform,
+						Cmd: []string{"/workspace/source-code"},
 					},
 				).
 				Return(nil),
@@ -261,11 +259,11 @@ func TestExecutor_Execute(t *testing.T) {
 						Executable: "/bin/prescan",
 						EnvVars:    envVars,
 						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
 							scratchHostPath + ":" + scratchMountPath,
 							sourceCodeHostPath + ":" + sourceCodeMountPath,
 						},
-						Cmd:      []string{"--from=/workspace/source-code", "--to=/workspace/scratch"},
-						Platform: platform,
+						Cmd: []string{"--from=/workspace/source-code", "--to=/workspace/scratch"},
 					},
 				).
 				Return(nil),
@@ -280,10 +278,10 @@ func TestExecutor_Execute(t *testing.T) {
 						Executable: "/bin/scan",
 						EnvVars:    envVars,
 						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
 							scratchHostPath + ":" + scratchMountPath,
 						},
-						Cmd:      []string{"/workspace/scratch"},
-						Platform: platform,
+						Cmd: []string{"/workspace/scratch"},
 					},
 				).
 				Return(nil),
@@ -298,10 +296,10 @@ func TestExecutor_Execute(t *testing.T) {
 						Executable: "/bin/scan",
 						EnvVars:    appendAndSort(envVars, "FROM=/workspace/source-code", "TO=/workspace/scratch"),
 						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
 							scratchHostPath + ":" + scratchMountPath,
 							sourceCodeHostPath + ":" + sourceCodeMountPath,
 						},
-						Platform: platform,
 					},
 				).
 				Return(nil),
@@ -311,12 +309,13 @@ func TestExecutor_Execute(t *testing.T) {
 				RunAndWait(
 					ctx,
 					engine.ContainerConfig{
-						Name:           enricherComponentStepName,
-						Image:          enricherComponentImage,
-						Executable:     "/bin/enrich",
-						VolumeBindings: []string{},
-						EnvVars:        envVars,
-						Platform:       platform,
+						Name:       enricherComponentStepName,
+						Image:      enricherComponentImage,
+						Executable: "/bin/enrich",
+						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
+						},
+						EnvVars: envVars,
 					},
 				).
 				Return(nil),
@@ -326,12 +325,13 @@ func TestExecutor_Execute(t *testing.T) {
 				RunAndWait(
 					ctx,
 					engine.ContainerConfig{
-						Name:           filterComponentStepName,
-						Image:          filterComponentImage,
-						Executable:     "/bin/filter",
-						VolumeBindings: []string{},
-						EnvVars:        envVars,
-						Platform:       platform,
+						Name:       filterComponentStepName,
+						Image:      filterComponentImage,
+						Executable: "/bin/filter",
+						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
+						},
+						EnvVars: envVars,
 					},
 				).
 				Return(nil),
@@ -341,15 +341,16 @@ func TestExecutor_Execute(t *testing.T) {
 				RunAndWait(
 					ctx,
 					engine.ContainerConfig{
-						Name:           reporterComponentStepName,
-						Image:          reporterComponentImage,
-						Executable:     "/bin/report",
-						VolumeBindings: []string{},
+						Name:       reporterComponentStepName,
+						Image:      reporterComponentImage,
+						Executable: "/bin/report",
+						VolumeBindings: []string{
+							path.Join(absPath, fmt.Sprintf("%s:/workspace", ".smithy")),
+						},
 						Cmd: []string{
 							"-arg1=1",
 						},
-						EnvVars:  envVars,
-						Platform: platform,
+						EnvVars: envVars,
 					},
 				).
 				Return(nil),

smithyctl/main.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"log"
+
+	"github.com/smithy-security/smithy/smithyctl/command/component"
+	"github.com/smithy-security/smithy/smithyctl/command/version"
+	"github.com/smithy-security/smithy/smithyctl/command/workflow"
+	"github.com/smithy-security/smithy/smithyctl/internal/command"
+)
+
+func main() {
+	if err := command.
+		NewRootCommand(
+			version.NewCommand(),
+			component.NewCommand(),
+			workflow.NewCommand(),
+		).
+		Execute(); err != nil {
+		log.Fatalf("could not execute smithyctl: %v", err)
+	}
+}