Add a compilation tag swagger to permit usage in external module

2023-09-07 12:51:41 +02:00 · 2023-09-07 12:51:41 +02:00 · a27b7053b7
parent 890806aeee
commit a27b7053b7
5 changed files with 155 additions and 34 deletions
--- a/.drone.yml
+++ b/.drone.yml
@ -60,7 +60,7 @@ steps:
  - sed -i '/npm run build/d' ui/assets.go
  - go install github.com/swaggo/swag/cmd/swag@latest
  - go generate -v ./...
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
  - ln happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH} happydomain
  environment:
    CGO_ENABLED: 0
@ -76,7 +76,7 @@ steps:
  - sed -i '/npm run build/d' ui/assets.go
  - go install github.com/swaggo/swag/cmd/swag@latest
  - go generate -v ./...
-  - go build -v -tags netgo -ldflags '-w -X main.Version=${DRONE_TAG##v} -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X main.Version=${DRONE_TAG##v} -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
  - ln happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH} happydomain
  environment:
    CGO_ENABLED: 0
@ -131,7 +131,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk add --no-cache git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
  environment:
    CGO_ENABLED: 0
    GOOS: darwin
@ -145,7 +145,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk add --no-cache git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
  environment:
    CGO_ENABLED: 0
    GOOS: darwin
@ -231,7 +231,7 @@ steps:
  - sed -i '/npm run build/d' ui/assets.go
  - go install github.com/swaggo/swag/cmd/swag@latest
  - go generate -v ./...
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
  - ln happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH} happydomain
  environment:
    CGO_ENABLED: 0
@ -247,7 +247,7 @@ steps:
  - sed -i '/npm run build/d' ui/assets.go
  - go install github.com/swaggo/swag/cmd/swag@latest
  - go generate -v ./...
-  - go build -v -tags netgo -ldflags '-w -X main.Version=${DRONE_TAG##v} -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X main.Version=${DRONE_TAG##v} -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}
  - ln happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH} happydomain
  environment:
    CGO_ENABLED: 0
@ -294,7 +294,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk add --no-cache git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
  environment:
    CGO_ENABLED: 0
    GOOS: darwin
@ -308,7 +308,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk add --no-cache git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-darwin-${DRONE_STAGE_ARCH}
  environment:
    CGO_ENABLED: 0
    GOOS: darwin
@ -394,7 +394,7 @@ steps:
  - sed -i '/npm run build/d' ui/assets.go
  - go install github.com/swaggo/swag/cmd/swag@latest
  - go generate -v ./...
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}el
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}el
  environment:
    CGO_ENABLED: 0
    GOARM: 5
@ -413,7 +413,7 @@ steps:
  - sed -i '/npm run build/d' ui/assets.go
  - go install github.com/swaggo/swag/cmd/swag@latest
  - go generate -v ./...
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}el
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}el
  environment:
    CGO_ENABLED: 0
    GOARM: 5
@ -460,7 +460,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk --no-cache add build-base git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}hf
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}hf
  environment:
    CGO_ENABLED: 0
    GOARM: 6
@ -476,7 +476,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk --no-cache add build-base git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}hf
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}hf
  environment:
    CGO_ENABLED: 0
    GOARM: 6
@ -526,7 +526,7 @@ steps:
  - "[ -d docs ] || sed -i '/npm run build/d' ui/assets.go"
  - "[ -d docs ] || go install github.com/swaggo/swag/cmd/swag@latest"
  - "[ -d docs ] || go generate -v ./..."
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_BRANCH}-${DRONE_COMMIT}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7
  - ln happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7 happydomain
  environment:
    CGO_ENABLED: 0
@ -540,7 +540,7 @@ steps:
  image: golang:1-alpine
  commands:
  - apk --no-cache add build-base git
-  - go build -v -tags netgo -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7
+  - go build -v -tags netgo,swagger -ldflags '-w -X "main.Version=${DRONE_TAG##v}" -X main.build=${DRONE_BUILD_NUMBER}' -o happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7
  - ln happydomain-${DRONE_STAGE_OS}-${DRONE_STAGE_ARCH}v7 happydomain
  environment:
    CGO_ENABLED: 0
--- a/api/routes.go
+++ b/api/routes.go
@ -32,16 +32,9 @@
 package api

 import (
-	"fmt"
-	"net/http"
-	"strings"
-
 	"github.com/gin-gonic/gin"
-	swaggerfiles "github.com/swaggo/files"
-	ginSwagger "github.com/swaggo/gin-swagger"

 	"git.happydns.org/happyDomain/config"
-	docs "git.happydns.org/happyDomain/docs"
 )

 //	@title			happyDomain API
@ -82,17 +75,5 @@ func DeclareRoutes(cfg *config.Options, router *gin.Engine) {
 	declareProviderSettingsRoutes(cfg, apiAuthRoutes)
 	declareUsersAuthRoutes(cfg, apiAuthRoutes)

-	// Expose Swagger
-	if cfg.ExternalURL.URL.Host != "" {
-		tmp := cfg.ExternalURL.URL.String()
-		docs.SwaggerInfo.Host = tmp[strings.Index(tmp, "://")+3:]
-	} else {
-		docs.SwaggerInfo.Host = fmt.Sprintf("localhost%s", cfg.Bind[strings.Index(cfg.Bind, ":"):])
-	}
-	docs.SwaggerInfo.BasePath = "/api"
-	if cfg.BaseURL != "" {
-		docs.SwaggerInfo.BasePath = cfg.BaseURL + docs.SwaggerInfo.BasePath
-	}
-	router.GET("/swagger", func(c *gin.Context) { c.Redirect(http.StatusFound, "./swagger/index.html") })
-	router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
+	declareRouteSwagger(cfg, router)
 }
--- a/api/swagger-nodoc.go
+++ b/api/swagger-nodoc.go
@ -0,0 +1,43 @@
+// Copyright or © or Copr. happyDNS (2021)
+//
+// contact@happydomain.org
+//
+// This software is a computer program whose purpose is to provide a modern
+// interface to interact with DNS systems.
+//
+// This software is governed by the CeCILL license under French law and abiding
+// by the rules of distribution of free software.  You can use, modify and/or
+// redistribute the software under the terms of the CeCILL license as
+// circulated by CEA, CNRS and INRIA at the following URL
+// "http://www.cecill.info".
+//
+// As a counterpart to the access to the source code and rights to copy, modify
+// and redistribute granted by the license, users are provided only with a
+// limited warranty and the software's author, the holder of the economic
+// rights, and the successive licensors have only limited liability.
+//
+// In this respect, the user's attention is drawn to the risks associated with
+// loading, using, modifying and/or developing or reproducing the software by
+// the user in light of its specific status of free software, that may mean
+// that it is complicated to manipulate, and that also therefore means that it
+// is reserved for developers and experienced professionals having in-depth
+// computer knowledge. Users are therefore encouraged to load and test the
+// software's suitability as regards their requirements in conditions enabling
+// the security of their systems and/or data to be ensured and, more generally,
+// to use and operate it in the same conditions as regards security.
+//
+// The fact that you are presently reading this means that you have had
+// knowledge of the CeCILL license and that you accept its terms.
+
+//go:build !swagger
+
+package api
+
+import (
+	"github.com/gin-gonic/gin"
+
+	"git.happydns.org/happyDomain/config"
+)
+
+func declareRouteSwagger(cfg *config.Options, router *gin.Engine) {
+}
--- a/api/swagger.go
+++ b/api/swagger.go
@ -0,0 +1,63 @@
+// Copyright or © or Copr. happyDNS (2021)
+//
+// contact@happydomain.org
+//
+// This software is a computer program whose purpose is to provide a modern
+// interface to interact with DNS systems.
+//
+// This software is governed by the CeCILL license under French law and abiding
+// by the rules of distribution of free software.  You can use, modify and/or
+// redistribute the software under the terms of the CeCILL license as
+// circulated by CEA, CNRS and INRIA at the following URL
+// "http://www.cecill.info".
+//
+// As a counterpart to the access to the source code and rights to copy, modify
+// and redistribute granted by the license, users are provided only with a
+// limited warranty and the software's author, the holder of the economic
+// rights, and the successive licensors have only limited liability.
+//
+// In this respect, the user's attention is drawn to the risks associated with
+// loading, using, modifying and/or developing or reproducing the software by
+// the user in light of its specific status of free software, that may mean
+// that it is complicated to manipulate, and that also therefore means that it
+// is reserved for developers and experienced professionals having in-depth
+// computer knowledge. Users are therefore encouraged to load and test the
+// software's suitability as regards their requirements in conditions enabling
+// the security of their systems and/or data to be ensured and, more generally,
+// to use and operate it in the same conditions as regards security.
+//
+// The fact that you are presently reading this means that you have had
+// knowledge of the CeCILL license and that you accept its terms.
+
+//go:build swagger
+
+package api
+
+import (
+	"fmt"
+	"net/http"
+	"strings"
+
+	"github.com/gin-gonic/gin"
+	swaggerfiles "github.com/swaggo/files"
+	ginSwagger "github.com/swaggo/gin-swagger"
+
+	"git.happydns.org/happyDomain/config"
+	docs "git.happydns.org/happyDomain/docs"
+)
+
+func declareRouteSwagger(cfg *config.Options, router *gin.Engine) {
+	// Expose Swagger
+	if cfg.ExternalURL.URL.Host != "" {
+		tmp := cfg.ExternalURL.URL.String()
+		docs.SwaggerInfo.Host = tmp[strings.Index(tmp, "://")+3:]
+	} else {
+		docs.SwaggerInfo.Host = fmt.Sprintf("localhost%s", cfg.Bind[strings.Index(cfg.Bind, ":"):])
+	}
+	docs.SwaggerInfo.BasePath = "/api"
+	if cfg.BaseURL != "" {
+		docs.SwaggerInfo.BasePath = cfg.BaseURL + docs.SwaggerInfo.BasePath
+	}
+	router.GET("/swagger", func(c *gin.Context) { c.Redirect(http.StatusFound, "./swagger/index.html") })
+	router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerfiles.Handler))
+}
--- a/docs/presence.go
+++ b/docs/presence.go
@ -0,0 +1,34 @@
+// Copyright or © or Copr. happyDNS (2021)
+//
+// contact@happydomain.org
+//
+// This software is a computer program whose purpose is to provide a modern
+// interface to interact with DNS systems.
+//
+// This software is governed by the CeCILL license under French law and abiding
+// by the rules of distribution of free software.  You can use, modify and/or
+// redistribute the software under the terms of the CeCILL license as
+// circulated by CEA, CNRS and INRIA at the following URL
+// "http://www.cecill.info".
+//
+// As a counterpart to the access to the source code and rights to copy, modify
+// and redistribute granted by the license, users are provided only with a
+// limited warranty and the software's author, the holder of the economic
+// rights, and the successive licensors have only limited liability.
+//
+// In this respect, the user's attention is drawn to the risks associated with
+// loading, using, modifying and/or developing or reproducing the software by
+// the user in light of its specific status of free software, that may mean
+// that it is complicated to manipulate, and that also therefore means that it
+// is reserved for developers and experienced professionals having in-depth
+// computer knowledge. Users are therefore encouraged to load and test the
+// software's suitability as regards their requirements in conditions enabling
+// the security of their systems and/or data to be ensured and, more generally,
+// to use and operate it in the same conditions as regards security.
+//
+// The fact that you are presently reading this means that you have had
+// knowledge of the CeCILL license and that you accept its terms.
+
+package docs
+
+// This is an empty file to ensure docs module exists