support to load swaggers from an extension #639
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Check failure
Code scanning / CodeQL
Clear-text logging of sensitive information High
Copilot Autofix
AI 8 months ago
To fix the problem, we should avoid logging the full path that includes potentially sensitive information. Instead, we can log only the filename or a sanitized version of the path. This way, we maintain the functionality of logging progress without exposing sensitive data.
DownloadSwaggerDatafunction, change the logging statement on line 52 to log only thetargetFileinstead of the full path.