support to load swaggers from an extension

Author: LinuxSuRen

cmd/extension.go

@@ -17,75 +17,75 @@ limitations under the License.
 package cmd
 
 import (
-    "fmt"
-    "io"
-    "path/filepath"
-    "runtime"
-    "time"
+	"fmt"
+	"io"
+	"path/filepath"
+	"runtime"
+	"time"
 
-    "github.com/linuxsuren/api-testing/pkg/downloader"
-    "github.com/spf13/cobra"
+	"github.com/linuxsuren/api-testing/pkg/downloader"
+	"github.com/spf13/cobra"
 )
 
 type extensionOption struct {
-    ociDownloader downloader.PlatformAwareOCIDownloader
-    output        string
-    registry      string
-    kind          string
-    tag           string
-    os            string
-    arch          string
-    timeout       time.Duration
-    imagePrefix   string
+	ociDownloader downloader.PlatformAwareOCIDownloader
+	output        string
+	registry      string
+	kind          string
+	tag           string
+	os            string
+	arch          string
+	timeout       time.Duration
+	imagePrefix   string
 }
 
 func createExtensionCommand(ociDownloader downloader.PlatformAwareOCIDownloader) (c *cobra.Command) {
-    opt := &extensionOption{
-        ociDownloader: ociDownloader,
-    }
-    c = &cobra.Command{
-        Use:   "extension",
-        Short: "Download extension binary files",
-        Long:  "Download the store extension files",
-        Args:  cobra.MinimumNArgs(1),
-        RunE:  opt.runE,
-    }
-    flags := c.Flags()
-    flags.StringVarP(&opt.output, "output", "", ".", "The target directory")
-    flags.StringVarP(&opt.tag, "tag", "", "", "The extension image tag, try to find the latest one if this is empty")
-    flags.StringVarP(&opt.registry, "registry", "", "", "The target extension image registry, supported: docker.io, ghcr.io")
-    flags.StringVarP(&opt.kind, "kind", "", "store", "The extension kind")
-    flags.StringVarP(&opt.os, "os", "", runtime.GOOS, "The OS")
-    flags.StringVarP(&opt.arch, "arch", "", runtime.GOARCH, "The architecture")
-    flags.DurationVarP(&opt.timeout, "timeout", "", time.Minute, "The timeout of downloading")
-    flags.StringVarP(&opt.imagePrefix, "image-prefix", "", "linuxsuren", "The prefix for the image address")
-    return
+	opt := &extensionOption{
+		ociDownloader: ociDownloader,
+	}
+	c = &cobra.Command{
+		Use:   "extension",
+		Short: "Download extension binary files",
+		Long:  "Download the store extension files",
+		Args:  cobra.MinimumNArgs(1),
+		RunE:  opt.runE,
+	}
+	flags := c.Flags()
+	flags.StringVarP(&opt.output, "output", "", ".", "The target directory")
+	flags.StringVarP(&opt.tag, "tag", "", "", "The extension image tag, try to find the latest one if this is empty")
+	flags.StringVarP(&opt.registry, "registry", "", "", "The target extension image registry, supported: docker.io, ghcr.io")
+	flags.StringVarP(&opt.kind, "kind", "", "store", "The extension kind")
+	flags.StringVarP(&opt.os, "os", "", runtime.GOOS, "The OS")
+	flags.StringVarP(&opt.arch, "arch", "", runtime.GOARCH, "The architecture")
+	flags.DurationVarP(&opt.timeout, "timeout", "", time.Minute, "The timeout of downloading")
+	flags.StringVarP(&opt.imagePrefix, "image-prefix", "", "linuxsuren", "The prefix for the image address")
+	return
 }
 
 func (o *extensionOption) runE(cmd *cobra.Command, args []string) (err error) {
-    o.ociDownloader.WithOS(o.os)
-    o.ociDownloader.WithArch(o.arch)
-    o.ociDownloader.WithRegistry(o.registry)
-    o.ociDownloader.WithImagePrefix(o.imagePrefix)
-    o.ociDownloader.WithTimeout(o.timeout)
-    o.ociDownloader.WithKind(o.kind)
-    o.ociDownloader.WithContext(cmd.Context())
+	o.ociDownloader.WithOS(o.os)
+	o.ociDownloader.WithArch(o.arch)
+	o.ociDownloader.WithRegistry(o.registry)
+	o.ociDownloader.WithImagePrefix(o.imagePrefix)
+	o.ociDownloader.WithTimeout(o.timeout)
+	o.ociDownloader.WithKind(o.kind)
+	o.ociDownloader.WithContext(cmd.Context())
 
-    for _, arg := range args {
-        var reader io.Reader
-        if reader, err = o.ociDownloader.Download(arg, o.tag, ""); err != nil {
-            return
-        } else if reader == nil {
-            err = fmt.Errorf("cannot find %s", arg)
-            return
-        }
-        extFile := o.ociDownloader.GetTargetFile()
-        cmd.Println("found target file", extFile)
+	for _, arg := range args {
+		var reader io.Reader
+		if reader, err = o.ociDownloader.Download(arg, o.tag, ""); err != nil {
+			return
+		} else if reader == nil {
+			err = fmt.Errorf("cannot find %s", arg)
+			return
+		}
+		extFile := o.ociDownloader.GetTargetFile()
+		cmd.Println("found target file", extFile)
 
-        targetFile := filepath.Base(extFile)
-        if err = downloader.WriteTo(reader, o.output, targetFile); err == nil {
-            cmd.Println("downloaded", targetFile)
-        }
-    }
-    return
+		targetFile := filepath.Base(extFile)
+		if err = downloader.WriteTo(reader, o.output, targetFile); err == nil {
+			cmd.Println("downloaded", targetFile)
+		}
+	}
+	return
 }

cmd/server.go

@@ -22,6 +22,7 @@ import (
 	"context"
 	"errors"
 	"fmt"
+	"github.com/linuxsuren/api-testing/pkg/apispec"
 	"net"
 	"net/http"
 	"os"
@@ -302,6 +303,15 @@ func (o *serverOption) runE(cmd *cobra.Command, args []string) (err error) {
 		_ = o.httpServer.Shutdown(ctx)
 	}()
 
+	go func() {
+		err := apispec.DownloadSwaggerData("", extDownloader)
+		if err != nil {
+			fmt.Println("failed to download swagger data", err)
+		} else {
+			fmt.Println("success to download swagger data")
+		}
+	}()
+
 	mux := runtime.NewServeMux(runtime.WithMetadata(server.MetadataStoreFunc),
 		runtime.WithMarshalerOption("application/json+pretty", &runtime.JSONPb{
 			MarshalOptions: protojson.MarshalOptions{
@@ -342,6 +352,7 @@ func (o *serverOption) runE(cmd *cobra.Command, args []string) (err error) {
 		mux.HandlePath(http.MethodGet, "/get", o.getAtestBinary)
 		mux.HandlePath(http.MethodPost, "/runner/{suite}/{case}", service.WebRunnerHandler)
 		mux.HandlePath(http.MethodGet, "/api/v1/sbom", service.SBomHandler)
+		mux.HandlePath(http.MethodGet, "/api/v1/swaggers", apispec.SwaggersHandler)
 
 		postRequestProxyFunc := postRequestProxy(o.skyWalking)
 		mux.HandlePath(http.MethodPost, "/browser/{app}", postRequestProxyFunc)

console/atest-ui/src/views/TestSuite.vue

@@ -4,7 +4,7 @@ import { reactive, ref, watch } from 'vue'
 import { Edit, CopyDocument, Delete } from '@element-plus/icons-vue'
 import type { FormInstance, FormRules } from 'element-plus'
 import type { Suite, TestCase, Pair } from './types'
-import { NewSuggestedAPIsQuery, GetHTTPMethods } from './types'
+import { NewSuggestedAPIsQuery, GetHTTPMethods, SwaggerSuggestion } from './types'
 import EditButton from '../components/EditButton.vue'
 import { Cache } from './cache'
 import { useI18n } from 'vue-i18n'
@@ -20,6 +20,7 @@ const props = defineProps({
 })
 const emit = defineEmits(['updated'])
 let querySuggestedAPIs = NewSuggestedAPIsQuery(Cache.GetCurrentStore().name, props.name!)
+const querySwaggers = SwaggerSuggestion()
 
 const suite = ref({
   name: '',
@@ -325,7 +326,10 @@ const renameTestSuite = (name: string) => {
             </el-select>
           </td>
           <td>
-            <el-input class="mx-1" v-model="suite.spec.url" placeholder="API Spec URL"></el-input>
+              <el-autocomplete
+                  v-model="suite.spec.url"
+                  :fetch-suggestions="querySwaggers"
+              />
           </td>
         </tr>
       </table>

console/atest-ui/src/views/net.ts

@@ -620,6 +620,12 @@ function GetSuggestedAPIs(name: string,
     .then(callback)
 }
 
+function GetSwaggers(callback: (d: any) => void) {
+    fetch(`/api/v1/swaggers`, {})
+        .then(DefaultResponseProcess)
+        .then(callback)
+}
+
 function ReloadMockServer(config: any) {
   const requestOptions = {
     method: 'POST',
@@ -812,7 +818,7 @@ export const API = {
   CreateOrUpdateStore, GetStores, DeleteStore, VerifyStore,
   FunctionsQuery,
   GetSecrets, DeleteSecret, CreateOrUpdateSecret,
-  GetSuggestedAPIs,
+  GetSuggestedAPIs, GetSwaggers,
   ReloadMockServer, GetMockConfig, SBOM, DataQuery,
   getToken
 }

console/atest-ui/src/views/types.ts

@@ -102,6 +102,28 @@ export function NewSuggestedAPIsQuery(store: string, suite: string) {
     })
   }
 }
+
+interface SwaggerItem {
+    value: string
+}
+
+export function SwaggerSuggestion() {
+    return function (queryString: string, cb: (arg: any) => void) {
+        API.GetSwaggers((e) => {
+            var swaggers = [] as SwaggerItem[]
+            e.forEach((item: string) => {
+                swaggers.push({
+                    "value": `atest://${item}`
+                })
+            })
+
+            const results = queryString ? swaggers.filter((item: SwaggerItem) => {
+                return item.value.toLowerCase().indexOf(queryString.toLowerCase()) != -1
+            }) : swaggers
+            cb(results.slice(0, 10))
+        })
+    }
+}
 export function CreateFilter(queryString: string) {
   return (v: Pair) => {
     return v.value.toLowerCase().indexOf(queryString.toLowerCase()) !== -1

pkg/apispec/remote_swagger.go

@@ -0,0 +1,127 @@
+/*
+Copyright 2025 API Testing Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package apispec
+
+import (
+	"archive/tar"
+	"compress/gzip"
+	"encoding/json"
+	"fmt"
+	"github.com/linuxsuren/api-testing/pkg/downloader"
+	"github.com/linuxsuren/api-testing/pkg/util/home"
+	"io"
+	"net/http"
+	"os"
+	"path/filepath"
+)
+
+func DownloadSwaggerData(output string, dw downloader.PlatformAwareOCIDownloader) (err error) {
+	dw.WithKind("data")
+	dw.WithOS("")
+
+	var reader io.Reader
+	if reader, err = dw.Download("swagger", "", ""); err != nil {
+		return
+	}
+
+	extFile := dw.GetTargetFile()
+
+	if output == "" {
+		output = home.GetUserDataDir()
+	}
+	if err = os.MkdirAll(filepath.Dir(output), 0755); err != nil {
+		return
+	}
+
+	targetFile := filepath.Base(extFile)
+	fmt.Println("start to save", filepath.Join(output, targetFile))
+	if err = downloader.WriteTo(reader, output, targetFile); err == nil {
+		err = decompressData(filepath.Join(output, targetFile))
+	}
+	return
+}
+
+func SwaggersHandler(w http.ResponseWriter, _ *http.Request,
+	_ map[string]string) {
+	swaggers := GetSwaggerList()
+	if data, err := json.Marshal(swaggers); err == nil {
+		_, _ = w.Write(data)
+	} else {
+		w.WriteHeader(http.StatusInternalServerError)
+	}
+}
+
+func GetSwaggerList() (swaggers []string) {
+	dataDir := home.GetUserDataDir()
+	_ = filepath.WalkDir(dataDir, func(path string, d os.DirEntry, err error) error {
+		if err != nil {
+			return err
+		}
+
+		if !d.IsDir() && filepath.Ext(path) == ".json" {
+			swaggers = append(swaggers, filepath.Base(path))
+		}
+		return nil
+	})
+	return
+}
+
+func decompressData(dataFile string) (err error) {
+	var file *os.File
+	file, err = os.Open(dataFile)
+	if err != nil {
+		return
+	}
+	defer file.Close()
+
+	var gzipReader *gzip.Reader
+	gzipReader, err = gzip.NewReader(file)
+	if err != nil {
+		return
+	}
+	defer gzipReader.Close()
+
+	tarReader := tar.NewReader(gzipReader)
+
+	for {
+		header, err := tarReader.Next()
+		if err == io.EOF {
+			break // 退出循环
+		}
+		if err != nil {
+			panic(err)
+		}
+
+		destPath := filepath.Join(filepath.Dir(dataFile), filepath.Base(header.Name))
+
+		switch header.Typeflag {
+		case tar.TypeReg:
+			destFile, err := os.OpenFile(destPath, os.O_CREATE|os.O_WRONLY, os.FileMode(header.Mode))
+			if err != nil {
+				panic(err)
+			}
+			defer destFile.Close()
+
+			if _, err := io.Copy(destFile, tarReader); err != nil {
+				panic(err)
+			}
+		default:
+			fmt.Printf("Skipping entry type %c: %s\n", header.Typeflag, header.Name)
+		}
+	}
+	return
+}