MAJOR: makefile: add command to generate swagger generated files

oktalz · mjuraga · commit 2deff727cf2d · 2021-12-06T20:42:18.000+01:00
with `make swagger` its now possible to generate swagger read only files.
swagger version is determined and pulled from client-native project that
also holds models for dataplaneapi.

this directive also automaticly handle replace directives in go.mod
file. if different client-native is used, it uses that repository for
downloading correct specification, both for github and gitlab repositories.

also if correct swagger and jq is installed,
there is an option to run script directly on machine
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -9,50 +9,11 @@ This document is a short guide for contributing to this project.
 Data Plane API is generated using [go-swagger](https://github.com/go-swagger/go-swagger) from the swagger spec found [here](https://github.com/haproxytech/client-native/blob/master/specification/build/haproxy_spec.yaml) using the following command.
 
 ```
-./swagger generate server -f haproxy_spec.yaml \
-    -A "Data Plane" \
-    -t $GOPATH/src/github.com/haproxytech/ \
-    --existing-models github.com/haproxytech/client-native/v2/models \
-    --exclude-main \
-    --skip-models \
-    -s dataplaneapi \
-    --tags=Discovery \
-    --tags=ServiceDiscovery \
-    --tags=Information \
-    --tags=Specification \
-    --tags=SpecificationOpenapiv3 \
-    --tags=Transactions \
-    --tags=Sites \
-    --tags=Stats \
-    --tags=Global \
-    --tags=Frontend \
-    --tags=Backend \
-    --tags=Bind \
-    --tags=Server \
-    --tags=Configuration \
-    --tags=HTTPRequestRule \
-    --tags=HTTPResponseRule \
-    --tags=BackendSwitchingRule \
-    --tags=ServerSwitchingRule \
-    --tags=TCPResponseRule \
-    --tags=TCPRequestRule \
-    --tags=Filter \
-    --tags=StickRule \
-    --tags=LogTarget \
-    --tags=Reloads \
-    --tags=ACL \
-    --tags=Defaults \
-    --tags=StickTable \
-    --tags=Maps \
-    --tags=Nameserver \
-    --tags=Cluster \
-    --tags=Peer \
-    --tags=PeerEntry \
-    --tags=Resolver \
-    --tags=Spoe \
-    --tags=SpoeTransactions \
-    --tags=Storage \
-    -r ~/dataplaneapi-specification/copyright.txt
+make swagger
+```
+or if you prefer to run it directly (not in docker)
+```
+make swagger-native
 ```
 
 This command generates some of the files in this project, which are marked with // Code generated by go-swagger; DO NOT EDIT.
diff --git a/Makefile b/Makefile
@@ -6,6 +6,7 @@ GIT_TAG_COMMIT=$(shell git rev-parse --short ${GIT_LAST_TAG})
 GIT_MODIFIED1=$(shell git diff "${GIT_HEAD_COMMIT}" "${GIT_TAG_COMMIT}" --quiet || echo .dev)
 GIT_MODIFIED2=$(shell git diff --quiet || echo .dirty)
 GIT_MODIFIED=${GIT_MODIFIED1}${GIT_MODIFIED2}
+SWAGGER_VERSION=${shell curl -s https://raw.githubusercontent.com/haproxytech/client-native/master/Makefile | grep SWAGGER_VERSION -m 1 | awk -F"=" '{print $$2}'}
 BUILD_DATE=$(shell date -u '+%Y-%m-%dT%H:%M:%SZ')
 CGO_ENABLED?=0
 
@@ -25,3 +26,16 @@ build:
 .PHONY: e2e
 e2e: build
 	TESTNAME=$(TESTNAME) TESTNUMBER=$(TESTNUMBER) TESTDESCRIPTION="$(TESTDESCRIPTION)" SKIP_CLEANUP=$(SKIP_CLEANUP) PREWIPE=$(PREWIPE) HAPROXY_VERSION=$(HAPROXY_VERSION) ./e2e/run.bash
+
+.PHONY: generate
+generate:
+	cd generate/swagger;docker build \
+		--build-arg SWAGGER_VERSION=${SWAGGER_VERSION} \
+		--build-arg UID=$(shell id -u) \
+		--build-arg GID=$(shell id -g) \
+		-t dataplaneapi-swagger-gen .
+	docker run --rm -it -v "$(PWD)":/data dataplaneapi-swagger-gen
+
+.PHONY: generate-native
+generate-native:
+	generate/swagger/script.sh
diff --git a/generate/swagger/Dockerfile b/generate/swagger/Dockerfile
@@ -0,0 +1,15 @@
+ARG SWAGGER_VERSION
+FROM quay.io/goswagger/swagger:$SWAGGER_VERSION
+
+WORKDIR /data
+ARG UID
+ARG GID
+COPY script.sh /generate/swagger/script.sh
+VOLUME ["/data"]
+
+RUN apk add bash jq && addgroup -g "$GID" -S docker && adduser -u "$UID" -S user -G docker && \
+    chmod +x /generate/swagger/script.sh && \
+    chown -R "${UID}:${GID}" /data
+
+USER user
+ENTRYPOINT ["/generate/swagger/script.sh"]
diff --git a/generate/swagger/script.sh b/generate/swagger/script.sh
@@ -0,0 +1,98 @@
+#!/bin/bash
+
+set -e
+SPEC_DIR=$(mktemp -d)
+echo " ---> source folder: $SPEC_DIR"
+DST_DIR=$(mktemp -d)
+echo " ---> generate folder: $DST_DIR"
+# see if we have a replace directive
+CN_VERSION=$(go mod edit -json | jq -c -r '.Replace | .[] | select(.Old.Path | contains("github.com/haproxytech/client-native/v2")) | .New.Version' 2>/dev/null | awk -F"-" '{print $NF}') || ""
+# if hash is to short take all of it (example v1.0.0-dev1)
+[ "${#CN_VERSION}" -gt 0 ] && [ "${#CN_VERSION}" -lt 4 ] && CN_VERSION=$(go mod edit -json | jq -c -r '.Replace | .[] | select(.Old.Path | contains("github.com/haproxytech/client-native/v2")) | .New.Version')
+# check if version is ther, if not, use one from require
+[ -z "$CN_VERSION" ] && CN_VERSION=$(go mod edit -json | jq -c -r '.Require | .[] | select(.Path | contains("github.com/haproxytech/client-native/v2")) | .Version' 2>/dev/null | awk -F"-" '{print $NF}')
+echo " ---> version of client native used: $CN_VERSION"
+
+# extract repository
+REPO_PATH=$(go mod edit -json | jq -r '.Replace | .[] | select(.Old.Path | contains("github.com/haproxytech/client-native/v2")) | .New.Path'  2>/dev/null |  awk -F"/" '{print $2 "/" $3}') || ""
+[ -z "$REPO_PATH" ] && REPO_PATH=haproxytech/client-native
+
+# extract url, gitlab and github have different urls to raw content
+URL_PATH=$(go mod edit -json | jq -r '.Replace | .[] | select(.Old.Path | contains("github.com/haproxytech/client-native/v2")) | .New.Path' 2>/dev/null |  awk -F"/" '{print $1}') || ""
+EXTRA_PATH=""
+if [[ $URL_PATH =~ "gitlab" ]]; then
+   EXTRA_PATH="-/raw/"
+else
+  URL_PATH=raw.githubusercontent.com
+fi
+
+echo " ---> URL path: $URL_PATH"
+echo " ---> repository path: $REPO_PATH"
+SPEC_URL=https://$URL_PATH/$REPO_PATH/$EXTRA_PATH$CN_VERSION/specification
+echo " ---> fetching specification: $SPEC_URL/build/haproxy_spec.yaml"
+wget -q -O $SPEC_DIR/haproxy_spec.yaml $SPEC_URL/build/haproxy_spec.yaml
+echo " ---> fetching copyright: $SPEC_URL/copyright.txt"
+wget -q -O $SPEC_DIR/copyright.txt $SPEC_URL/copyright.txt
+
+echo "module github.com/haproxytech" > $DST_DIR/go.mod
+mkdir -p $DST_DIR/dataplaneapi/operations
+cp configure_data_plane.go $DST_DIR/dataplaneapi/configure_data_plane.go
+
+swagger generate server -f $SPEC_DIR/haproxy_spec.yaml \
+    -A "Data Plane" \
+    -t $DST_DIR \
+    --existing-models github.com/haproxytech/client-native/v2/models \
+    --exclude-main \
+    --skip-models \
+    -s dataplaneapi \
+    --tags=Discovery \
+    --tags=ServiceDiscovery \
+    --tags=Information \
+    --tags=Specification \
+    --tags=SpecificationOpenapiv3 \
+    --tags=Transactions \
+    --tags=Sites \
+    --tags=Stats \
+    --tags=Global \
+    --tags=Frontend \
+    --tags=Backend \
+    --tags=Bind \
+    --tags=Server \
+    --tags=Configuration \
+    --tags=HTTPRequestRule \
+    --tags=HTTPResponseRule \
+    --tags=BackendSwitchingRule \
+    --tags=ServerSwitchingRule \
+    --tags=TCPResponseRule \
+    --tags=TCPRequestRule \
+    --tags=Filter \
+    --tags=StickRule \
+    --tags=LogTarget \
+    --tags=Reloads \
+    --tags=ACL \
+    --tags=Defaults \
+    --tags=StickTable \
+    --tags=Maps \
+    --tags=Nameserver \
+    --tags=Cluster \
+    --tags=Peer \
+    --tags=PeerEntry \
+    --tags=Resolver \
+    --tags=Spoe \
+    --tags=SpoeTransactions \
+    --tags=Storage \
+    --tags="ACL Runtime" \
+    --tags=ServerTemplate \
+    -r $SPEC_DIR/copyright.txt
+
+echo " ---> removing doc.go"
+rm doc.go
+echo " ---> removing embedded_spec.go"
+rm embedded_spec.go
+echo " ---> removing server.go"
+rm server.go
+echo " ---> removing operations/*"
+rm -rf operations/*
+
+echo " ---> copy generated files to destination"
+cp -a $DST_DIR/dataplaneapi/. .
