@shortlink-org/portolan 0.2.4 → 0.4.0

package/plugins/extract-http-clients/main.go

@@ -0,0 +1,41 @@
+// Package extracthttpclients is portolan-extract-http-clients: outbound HTTP and SOAP calls
+// in a Go repository in, source-backed dependencies and flows out.
+package extracthttpclients
+
+import (
+	"fmt"
+	"io"
+	"path/filepath"
+
+	"github.com/shortlink-org/portolan/plugin"
+)
+
+type Options struct {
+	Context   string            `json:"context"`
+	Service   string            `json:"service"`
+	Peers     map[string]string `json:"peers,omitempty"`
+	Externals map[string]string `json:"externals,omitempty"`
+	Out       string            `json:"out,omitempty"`
+}
+
+// Serve answers one request on stdin with one response on stdout. The
+// process entrypoint and the wasm dispatcher in plugins/cmd/portolan-go both
+// call it.
+func Serve(stdin io.Reader, stdout io.Writer) error {
+	return run(stdin, stdout)
+}
+
+func run(stdin io.Reader, stdout io.Writer) error {
+	return plugin.Serve(stdin, stdout, descriptor(), func(req plugin.Request, opts Options) (plugin.Response, error) {
+		if req.Input.Root == "" {
+			return plugin.Response{}, fmt.Errorf("no input root: an extractor has nothing to read")
+		}
+		if opts.Context == "" {
+			opts.Context = slug(filepath.Base(req.Input.Root))
+		}
+		if opts.Service == "" {
+			opts.Service = slug(filepath.Base(req.Input.Root))
+		}
+		return extract(req.Input, opts)
+	})
+}

package/plugins/extract-k8s/options.schema.json

@@ -0,0 +1,32 @@
+{
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "context": {
+      "type": "string",
+      "description": "Slug of the bounded context this service belongs to. Defaults to the name of the input directory.",
+      "examples": ["shop"]
+    },
+    "service": {
+      "type": "string",
+      "description": "Slug of the service. Defaults to the name of the input directory. The workload is found by this name: a Deployment, StatefulSet, DaemonSet, Job or CronJob called so, or labelled so with `app` or `app.kubernetes.io/name`; when the tree holds exactly one workload, that one.",
+      "examples": ["pricing"]
+    },
+    "paths": {
+      "type": "array",
+      "items": { "type": "string" },
+      "description": "Directories under the input root that hold the manifests, so a repository's other YAML - compose files, CI, buf - is not walked. Left out, the whole root is read and anything without `apiVersion` and `kind` is passed over.",
+      "examples": [["deploy/k8s"]]
+    },
+    "namespace": {
+      "type": "string",
+      "description": "Read only the objects in this namespace. An object that names no namespace is read either way. Left out, every namespace.",
+      "examples": ["shop"]
+    },
+    "out": {
+      "type": "string",
+      "description": "Name of the fragment file, inside the step's output directory.",
+      "default": "k8s.json"
+    }
+  }
+}