feat: re-architecturing

Author: joe0BAB

.github/workflows/engine.yml .github/workflows/runtime.yml.github/workflows/engine.yml renamed to .github/workflows/runtime.yml

@@ -1,4 +1,4 @@
-name: Engine (cross platform)
+name: Runtime (cross platform)
 on:
   push:
     branches:
@@ -7,33 +7,33 @@ on:
       - 'v*'
   pull_request:
     paths:
-      - 'engine/**'
+      - 'runtime/**'
 jobs:
   tests-windows:
     permissions:
       id-token: write
       contents: read
-    name: WindowsEngineTests
+    name: WindowsRuntimeTests
     runs-on: windows-latest
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/go
         with:
           app_id: ${{ vars.DOCKER_READ_APP_ID }}
           app_private_key: ${{ secrets.DOCKER_READ_APP_PRIVATE_KEY }}
-      - name: Test engine
-        run: make engine-unit-tests
+      - name: Test runtime
+        run: make runtime-unit-tests
   tests-macos:
     permissions:
       id-token: write
       contents: read
-    name: MacOSEngineTests
+    name: MacOSRuntimeTests
     runs-on: macos-latest
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/go
         with:
           app_id: ${{ vars.DOCKER_READ_APP_ID }}
           app_private_key: ${{ secrets.DOCKER_READ_APP_PRIVATE_KEY }}
-      - name: Test engine
-        run: CGO_ENABLED=1 make engine-unit-tests
+      - name: Test runtime
+        run: CGO_ENABLED=1 make runtime-unit-tests

Makefile

@@ -81,8 +81,8 @@ keychain-linux-unit-tests:
 keychain-unit-tests:
 	CGO_ENABLED=1 go test -trimpath -race -v $$(go list ./store/keychain/...)
 
-engine-unit-tests:
-	go test -trimpath -race -v $$(go list ./engine/...)
+runtime-unit-tests:
+	go test -trimpath -race -v $$(go list ./runtime/...)
 
 proto-generate:
 	@docker buildx build $(DOCKER_BUILD_ARGS) -o . --target=proto-generate .

client/.gomodguard.yaml

@@ -1,7 +1,7 @@
 ---
 blocked:
   modules:
-    - github.com/docker/secrets-engine/engine:
+    - github.com/docker/secrets-engine/runtime:
         reason: "Forbidden dependency"
     - github.com/docker/secrets-engine/injector:
         reason: "Forbidden dependency"

client/client.go

@@ -102,7 +102,7 @@ func New(options ...Option) (Client, error) {
 	}
 	c := &http.Client{
 		Transport: &http.Transport{
-			// re-use the same connection to the engine, this speeds up subsequent
+			// re-use the same connection to the runtime, this speeds up subsequent
 			// calls.
 			MaxConnsPerHost:     api.DefaultClientMaxConnsPerHost,
 			MaxIdleConnsPerHost: api.DefaultClientMaxIdleConnsPerHost,

go.work

@@ -2,10 +2,10 @@ go 1.25.0
 
 use (
 	./client
-	./engine
 	./plugin
 	./plugins/credentialhelper
 	./plugins/pass
+	./runtime
 	./store
 	./x
 )

go.work.sum

@@ -46,6 +46,7 @@ github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2
 github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
 github.com/fvbommel/sortorder v1.1.0 h1:fUmoe+HLsBTctBDoaBwpQo5N+nrCp8g/BjKb/6ZQmYw=
 github.com/fvbommel/sortorder v1.1.0/go.mod h1:uk88iVf1ovNn1iLfgUVU2F9o5eO30ui720w+kxuqRs0=
+github.com/go-chi/chi/v5 v5.2.3/go.mod h1:L2yAIGWB3H+phAw1NxKwWM+7eUH/lU8pOMm5hHcoops=
 github.com/go-jose/go-jose/v4 v4.0.5/go.mod h1:s3P1lRrkT8igV8D9OjyL4WRyHvjB6a4JSllnOrmmBOA=
 github.com/go-jose/go-jose/v4 v4.1.1/go.mod h1:BdsZGqgdO3b6tTc6LSE56wcDbMMLuPsw5d4ZD5f94kA=
 github.com/go-kit/kit v0.8.0/go.mod h1:xBxKIO96dXMWWy0MnWVtmwkA9/13aqxPnvrjFYMA2as=

plugin/.gomodguard.yaml

@@ -3,7 +3,7 @@ blocked:
   modules:
     - github.com/docker/secrets-engine/client:
         reason: "Forbidden dependency"
-    - github.com/docker/secrets-engine/engine:
+    - github.com/docker/secrets-engine/runtime:
         reason: "Forbidden dependency"
     - github.com/docker/secrets-engine/injector:
         reason: "Forbidden dependency"

plugin/config.go

@@ -16,7 +16,7 @@ import (
 const hijackTimeout = 2 * time.Second
 
 // ManualLaunchOption to apply to a plugin during its creation
-// when it's manually launched (not by the secrets engine).
+// when it's manually launched (not by the secrets runtime).
 type ManualLaunchOption func(c *cfg) error
 
 // WithPluginName sets the name to use in plugin registration.
@@ -38,7 +38,7 @@ func WithRegistrationTimeout(timeout time.Duration) ManualLaunchOption {
 	}
 }
 
-// WithConnection sets an existing secrets engine connection to use.
+// WithConnection sets an existing secrets runtime connection to use.
 func WithConnection(conn net.Conn) ManualLaunchOption {
 	return func(s *cfg) error {
 		if s.conn != nil {

plugin/config_test.go

@@ -113,14 +113,14 @@ func Test_restoreConfig(t *testing.T) {
 		test func(t *testing.T)
 	}{
 		{
-			name: "no config from the engine",
+			name: "no config from the runtime",
 			test: func(t *testing.T) {
 				_, err := restoreConfig(&mockPlugin{})
 				assert.ErrorIs(t, err, errPluginNotLaunchedByEngine)
 			},
 		},
 		{
-			name: "invalid config from the engine",
+			name: "invalid config from the runtime",
 			test: func(t *testing.T) {
 				t.Setenv(api.PluginLaunchedByEngineVar, "test-plugin")
 				_, err := restoreConfig(&mockPlugin{})

plugin/setup.go

@@ -48,7 +48,7 @@ func setup(ctx context.Context, config cfg, onClose func(err error)) (io.Closer,
 		<-closed
 		ipc.Close()
 	}()
-	config.Logger.Printf("Started plugin (engine: %s@%s) %s...", runtimeCfg.Engine, runtimeCfg.Version, config.name)
+	config.Logger.Printf("Started plugin (runtime: %s@%s) %s...", runtimeCfg.Engine, runtimeCfg.Version, config.name)
 	close(setupCompleted)
 	return ipc, nil
 }