chore: #174 merge 1.x on master before release

Signed-off-by: Laurent Broudoux <[email protected]>

Author: lbroudoux

.github/workflows/build-verify.yml

@@ -27,7 +27,7 @@ jobs:
         run: echo "date=$(date +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_OUTPUT
 
       - name: Checkout Code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5.0.0
 
       - name: Setup Go
         uses: actions/setup-go@44694675825211faa026b3c33043df3e48a5fa00 #v6.0.0
@@ -37,19 +37,30 @@ jobs:
 
       - name: Build Go packages
         run: |
-          ./build-binaries.sh github.com/microcks/microcks-cli
+          make clean
+          make build-binaries
 
       - name: Set environment for branch
         run: |
           set -x
           if [[ $GITHUB_REF == 'refs/heads/master' ]]; then
             echo "IMAGE_TAG=nightly" >> "$GITHUB_ENV"
+            echo "IMAGE_TAG=nightly" >> "$GITHUB_OUTPUT"
             echo "PACKAGE_IMAGE=true" >> "$GITHUB_ENV"
+            echo "PACKAGE_IMAGE=true" >> "$GITHUB_OUTPUT"
+          elif [[ $GITHUB_REF == 'refs/heads/1.x' ]]; then
+            echo "IMAGE_TAG=next" >> "$GITHUB_ENV"
+            echo "IMAGE_TAG=next" >> "$GITHUB_OUTPUT"
+            echo "PACKAGE_IMAGE=true" >> "$GITHUB_ENV"
+            echo "PACKAGE_IMAGE=true" >> "$GITHUB_OUTPUT"
           elif [[ $GITHUB_REF == "refs/tags/$GITHUB_REF_NAME" ]]; then
             echo "IMAGE_TAG=$GITHUB_REF_NAME" >> "$GITHUB_ENV"
+            echo "IMAGE_TAG=$GITHUB_REF_NAME" >> "$GITHUB_OUTPUT"
             echo "PACKAGE_IMAGE=true" >> "$GITHUB_ENV"
+            echo "PACKAGE_IMAGE=true" >> "$GITHUB_OUTPUT"
           else
             echo "PACKAGE_IMAGE=false" >> "$GITHUB_ENV"
+            echo "PACKAGE_IMAGE=false" >> "$GITHUB_OUTPUT"
           fi
 
       - name: Install Cosign

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
       id-token: write
     steps:
       - name: Checkout Code
-        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v4
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 #v5.0.0
         with:
           ssh-key: ${{ secrets.RELEASE_DEPLOY_KEY }}
           fetch-depth: 0

.gitignore

@@ -12,4 +12,10 @@
 *.out
 
 # Ouput of the build-binaries script
-build/_output
+build/dist
+
+# .DS_Store file of MacOS
+.DS_Store
+
+# test data files
+**/testdata/**

.goreleaser.yaml

@@ -2,7 +2,7 @@ version: 2
 
 builds:
   - main: ./main.go
-    binary: microcks-cli
+    binary: microcks
     env:
       - CGO_ENABLED=0
 
@@ -25,7 +25,7 @@ signs:
       - "${artifact}"
 
 brews:
-  - name: microcks-cli
+  - name: microcks
     homepage: https://github.com/microcks/microcks-cli
     repository:
       owner: microcks

Makefile

@@ -0,0 +1,30 @@
+PACKAGE=github.com/microcks/microcks-cli
+CURRENT_DIR=$(shell pwd)
+DIST_DIR=${CURRENT_DIR}/build/dist
+CLI_NAME=microcks
+BIN_NAME=microcks
+WATCHER_NAME=watcher
+
+HOST_OS=$(shell go env GOOS)
+HOST_ARCH=$(shell go env GOARCH)
+
+.PHONY: build-local
+build-local:
+	go build -o ${DIST_DIR}/${BIN_NAME}
+
+.PHONY: clean
+clean:
+	rm -rf ${CURRENT_DIR}/build/dist
+
+.PHONY: build-binaries
+build-binaries: 
+	make BIN_NAME=${CLI_NAME}-linux-amd64 GOOS=linux build-local
+	make BIN_NAME=${CLI_NAME}-linux-arm64 GOOS=linux GOARCH=arm64 build-local
+	make BIN_NAME=${CLI_NAME}-darwin-amd64 GOOS=darwin build-local
+	make BIN_NAME=${CLI_NAME}-darwin-arm64 GOOS=darwin GOARCH=arm64 build-local
+	make BIN_NAME=${CLI_NAME}-windows-amd64.exe GOOS=windows build-local
+	make BIN_NAME=${CLI_NAME}-windows-386.exe GOOS=windows GOARCH=386 build-local
+
+.PHONY: build-watcher
+build-watcher:
+	go build -o ${DIST_DIR}/${BIN_NAME}-${WATCHER_NAME} ${PACKAGE}/pkg/importer

README.md

@@ -43,128 +43,57 @@ To get involved with our community, please make sure you are familiar with the p
 
 ## Usage instructions
 
-Usage is simply `microcks-cli [command]`
-
-where `[command]` can be one of the following:
-
-* `version` to check this CLI version,
-* `help` to display usage informations,
-* `test` to launch new test on Microcks server.
-* `import` to import API artifacts on Microcks server.
-
-### Test command
-
-The `test` command has a bunch of arguments and flags so that you can use it that way:
-
-```
-microcks-cli test <apiName:apiVersion> <testEndpoint> <runner>
-        --microcksURL=<> --waitFor=5sec
-        --keycloakClientId=<> --keycloakClientSecret=<>
-```
-
-The arguments:
-
-* `<apiName:apiVersion>` : Service to test reference. Example: `'Beer Catalog API:0.9'`
-* `<testEndpoint>` : URL where is deployed implementation to test
-* `<runner>` : Test strategy (one of: `HTTP`, `SOAP`, `SOAP_UI`, `POSTMAN`, `OPEN_API_SCHEMA`, `ASYNC_API_SCHEMA`, `GRPC_PROTOBUF`, `GRAPHQL_SCHEMA`)
-
-The flags:
-
-* `--microcksURL` for the Microcks API endpoint,
-* `--waitFor` for the time to wait for test to finish (int + one of: milli, sec, min),
-* `--keycloakClientId` for the Keycloak Realm Service Account ClientId,
-* `--keycloakClientSecret` for the Keycloak Realm Service Account ClientSecret.
-
-> Since `0.5.2` release, `microcks-cli` also works in unauthenticated mode, without Keycloak being deployed and configured with your Microcks instance. However, you still have to specify the Keycloak flags on the command even if you put random values there. For eg. `--keycloakClientId=foo --keycloakClientSecret=bar`.
-
-Real life example command and execution:
-
-```sh
-$ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ POSTMAN \
-        --microcksURL=http://localhost:8080/api/ \
-        --keycloakClientId=microcks-serviceaccount \
-        --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 \
-        --waitFor=3sec
-[...]
-MicrocksClient got status for test "5c1781cf6310d94f8169384e" - success: false, inProgress: true
-MicrocksTester waiting for 2 seconds before checking again.
-MicrocksClient got status for test "5c1781cf6310d94f8169384e" - success: true, inProgress: false
-Full TestResult details are available here: http://localhost:8080/#/tests/5c1781cf6310d94f8169384e 
+### Usage
+```bash
+microcks [command] [flags]
 ```
 
-#### Advanced options
-
-The `test` command provides additional flags for advanced usages and options:
-
-* `--verbose` allows to dump on standard output all the HTTP requests and responses,
-* `--insecure` allows to interact with Microcks and Keycloak instances through HTTPS without checking certificates issuer CA,
-* `--caCerts=<path1,path2>` allows to specify additional certificates CRT files to add to trusted roots ones,
-* `--secretName='<Secret Name>'` is an optional flag specifying the name of a Secret to use for connecting endpoint,
-* `--filteredOperations=<JSON>` allows to filter a list of operations to launch a test for,
-* `--operationsHeaders=<JSON>` allows to override some operations headers for the tests to launch,
-* `--oAuth2Context=<JSON>` allows specification of an OAuth2 grant flow to execute before launching the test (starts with Microcks version `1.8.0`).
+### Available Commands
+| Command      | Description                                              | Documentation                                   |
+| ------------ | -------------------------------------------------------- | ----------------------------------------------- |
+| `login`      | Log in to a Microcks instance using Keycloak credentials | [`login`](documentation/cmd/login.md)           |
+| `logout`     | Log out and remove authentication from a given context   | [`logout`](documentation/cmd/logout.md)         |
+| `context`    | Manage CLI contexts (list, use, delete)                  | [`context`](documentation/cmd/context.md)       |
+| `start`      | Start a local Microcks instance via Docker/Podman        | [`start`](documentation/cmd/start.md)           |
+| `stop`       | Stop a local Microcks instance                           | [`stop`](documentation/cmd/stop.md)             |
+| `import`     | Import API spec files from local filesystem              | [`import`](documentation/cmd/import.md)         |
+| `import-url` | Import API spec files directly from a remote URL         | [`import-url`](documentation/cmd/import-url.md) |
+| `test`       | Run tests against a deployed API using selected runner   | [`test`](documentation/cmd/test.md)             |
+| `version`    | Print Microcks CLI version                               | [`version`](documentation/cmd/version.md)       |
+
+### Options
+
+| Flag                     | Description                                 |
+| ------------------------ | ------------------------------------------- |
+| `-h, --help`             | help for microck command                    |
+| `--config`               | Path to Microcks config file                |
+| `--microcks-context`     | Name of the Microcks context to use         |
+| `--verbose`              | Produce dumps of HTTP exchanges             |
+| `--insecure-tls`         | Allow insecure HTTPS connections            |
+| `--caCerts`              | Comma-separated paths of CA cert files      |
+| `--keycloakClientId`     | Keycloak Realm Service Account ClientId     |
+| `--keycloakClientSecret` | Keycloak Realm Service Account ClientSecret |
+| `--microcksURL`          | Microcks API URL                            |
 
-Overriden test operations headers is a JSON strings where 1st level keys are operation name (eg. `GET /beer`) or `globals` for header applying to all the operations of the API. Headers are specified as an array of objects defining `key` and `values` properties.
 
-Here's below an example of using some of this flags:
-
-```sh
-$ ./microcks-cli test 'Beer Catalog API:0.9' http://localhost:9090/api/ OPEN_API_SCHEMA \                           
-        --microcksURL=http://localhost:8080/api/ \
-        --keycloakClientId=microcks-serviceaccount \
-        --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1 \
-        --insecure --verbose  --waitFor=3sec \
-        --filteredOperations='["GET /beer", "GET /beer/{name}"]' \
-        --operationsHeaders='{"globals": [{"name": "x-api-key", "values": "my-values"}], "GET /beer": [{"name": "x-trace-id", "values": "xcvbnsdfghjklm"}]}' \
-        --oAuth2Context='{"clientId": "microcks-test", "clientSecret": "ab54d329-e435-41ae-a900-ec6b3fe15c54", "tokenUri": "https://idp.acme.org/realms/my-app/protocol/openid-connect/token", "grantType": "CLIENT_CREDENTIALS"}'
+## Installation
 
-MicrocksClient got status for test "64c25f7ddec62569f9a0ed95" - success: true, inProgress: false 
-Full TestResult details are available here: http://localhost:8080/#/tests/64c25f7ddec62569f9a0ed95 
+### Building from Source
+To build the CLI locally:
+```bash
+make build-local
 ```
 
-### Import command
-
-The `import` command has one argument and common flags with `test` command. You can use it that way:
-
+The resulting binary will be available at:
+```bash
+/build/dist/microcks
 ```
-microcks-cli import <specificationFile1[:primary],specificationFile2[:primary]>
-	--microcksURL=<>
-	--keycloakClientId=<> --keycloakClientSecret=<>
-```
-
-The arguments:
-
-* `<specificationFile1[:primary],specificationFile2[:primary]>` : Comma separated list of API specs to import with flag telling if it's a primary artifact. Example: `'specs/my-openapi.yaml:true,specs/my-postmancollection.json:false'`
-
-The flags:
 
-* `--microcksURL` for the Microcks API endpoint,
-* `--keycloakClientId` for the Keycloak Realm Service Account ClientId,
-* `--keycloakClientSecret` for the Keycloak Realm Service Account ClientSecret.
-
-> Since `0.5.2` release, `microcks-cli` also works in unauthenticated mode, without Keycloak being deployed and configured with your Microcks instance. However, you still have to specify the Keycloak flags on the command even if you put random values there. For eg. `--keycloakClientId=foo --keycloakClientSecret=bar`.
-
-Real life example command and execution:
-
-```sh
-$ ./microcks-cli import 'samples/weather-forecast-openapi.yml:true,samples/weather-forecast-postman.json:false' \
-        --microcksURL=http://localhost:8080/api/ \
-        --keycloakClientId=microcks-serviceaccount \
-        --keycloakClientSecret=7deb71e8-8c80-4376-95ad-00a399ee3ca1
-Microcks has discovered 'WeatherForecast API:1.1.0'
-Microcks has discovered 'WeatherForecast API:1.1.0'
+You can move it to a location in your $PATH for global usage, for example:
+```bash
+sudo mv build/dist/microcks /usr/local/bin/microcks
 ```
 
-#### Advanced options
-
-The `import` command provides additional flags for advanced usages and options:
-
-* `--verbose` allows to dump on standard output all the HTTP requests and responses,
-* `--insecure` allows to interact with Microcks and Keycloak instances through HTTPS without checking certificates issuer CA,
-* `--caCerts=<path1,path2>` allows to specify additional certificates CRT files to add to trusted roots ones,
-
-
-## Installation
 
 ### Binary
 

build/Dockerfile

@@ -5,7 +5,7 @@ WORKDIR /app
 ARG TARGETOS
 ARG TARGETARCH
 RUN CGO_ENABLED=0 GOOS=${TARGETOS} GOARCH=${TARGETARCH} \
-    go build -ldflags="-s -w" -o microcks-cli github.com/microcks/microcks-cli
+    go build -ldflags="-s -w" -o microcks github.com/microcks/microcks-cli
 
 # Build image
 FROM registry.access.redhat.com/ubi9/ubi-minimal:9.5-1742914212
@@ -19,12 +19,12 @@ LABEL maintainer="Laurent Broudoux <[email protected]>" \
       org.opencontainers.image.documentation="https://github.com/microcks/microcks-cli" \
       io.artifacthub.package.readme-url="https://raw.githubusercontent.com/microcks/microcks-cli/master/README.md"
 
-ENV CLI=/usr/local/bin/microcks-cli \
+ENV CLI=/usr/local/bin/microcks \
     USER_UID=1001 \
     USER_NAME=microcks-cli
 
 # install cli binary
-COPY --from=build-env /app/microcks-cli ${CLI}
+COPY --from=build-env /app/microcks ${CLI}
 
 COPY build/bin /usr/local/bin
 RUN  /usr/local/bin/user_setup

cmd/cmd.go

@@ -15,7 +15,50 @@
  */
 package cmd
 
-// Command define single method interface
-type Command interface {
-	Execute()
+import (
+	"github.com/microcks/microcks-cli/pkg/config"
+	"github.com/microcks/microcks-cli/pkg/connectors"
+	"github.com/microcks/microcks-cli/pkg/errors"
+	"github.com/spf13/cobra"
+)
+
+func NewCommad() *cobra.Command {
+
+	var clientOpts connectors.ClientOptions
+
+	command := &cobra.Command{
+		Use:          "microcks",
+		Short:        "A CLI tool for Microcks",
+		SilenceUsage: true,
+		Run: func(cmd *cobra.Command, args []string) {
+			cmd.HelpFunc()(cmd, args)
+		},
+		CompletionOptions: cobra.CompletionOptions{
+			HiddenDefaultCmd: true,
+		},
+	}
+
+	command.AddCommand(NewImportCommand(&clientOpts))
+	command.AddCommand(NewVersionCommand())
+	command.AddCommand(NewTestCommand(&clientOpts))
+	command.AddCommand(NewImportURLCommand(&clientOpts))
+	command.AddCommand(NewStartCommand(&clientOpts))
+	command.AddCommand(NewStopCommand(&clientOpts))
+	command.AddCommand(NewContextCommand(&clientOpts))
+	command.AddCommand(NewLoginCommand(&clientOpts))
+	command.AddCommand(NewLogoutCommand(&clientOpts))
+
+	defaultLocalConfigPath, err := config.DefaultLocalConfigPath()
+	errors.CheckError(err)
+	command.PersistentFlags().StringVar(&clientOpts.ConfigPath, "config", defaultLocalConfigPath, "Path to Microcks config")
+	command.PersistentFlags().StringVar(&clientOpts.Context, "microcks-context", "", "Name of the Microcks context to use")
+	command.PersistentFlags().BoolVar(&clientOpts.Verbose, "verbose", false, "Produce dumps of HTTP exchanges")
+	command.PersistentFlags().BoolVar(&clientOpts.InsecureTLS, "insecure-tls", false, "Whether to accept insecure HTTPS connection")
+	command.PersistentFlags().StringVar(&clientOpts.CaCertPaths, "caCerts", "", "Comma separated paths of CRT files to add to Root CAs")
+	command.PersistentFlags().StringVar(&clientOpts.ClientId, "keycloakClientId", "", "Keycloak Realm Service Account ClientId")
+	command.PersistentFlags().StringVar(&clientOpts.ClientSecret, "keycloakClientSecret", "", "Keycloak Realm Service Account ClientSecret")
+	command.PersistentFlags().StringVar(&clientOpts.ServerAddr, "microcksURL", "", "Microcks API URL")
+	command.MarkFlagsRequiredTogether("keycloakClientId", "microcksURL", "keycloakClientSecret")
+
+	return command
 }