generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add "many" subcommand to test multiple targets and produce a single H…
…TML report previous functionality is available under the "one" subcommand
- Loading branch information
Showing
11 changed files
with
330 additions
and
132 deletions.
There are no files selected for viewing
This file contains 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,17 @@ | ||
| on: | ||
| push: | ||
| branches: [main] | ||
| jobs: | ||
| pages: | ||
| permissions: | ||
| pages: write | ||
| id-token: write | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-go@v4 | ||
| - name: run for all SDKs | ||
| run: go run ./cmd/web5-spec-test many sdks/* | ||
| - uses: actions/upload-pages-artifact@v2 | ||
| - name: deploy GitHub Pages | ||
| uses: actions/deploy-pages@v2 |
This file contains 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 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 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,53 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
|
|
||
| "github.com/TBD54566975/web5-spec/reports" | ||
| "github.com/spf13/cobra" | ||
| "golang.org/x/exp/slog" | ||
| ) | ||
|
|
||
| var ( | ||
| testManyCmd = &cobra.Command{ | ||
| Use: "many dir [dir...]", | ||
| Args: cobra.MinimumNArgs(1), | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| allReports := []reports.Report{} | ||
| for _, dir := range args { | ||
| report, err := testOne(dir) | ||
| if err != nil { | ||
| slog.Error("error testing server", "dir", dir, "err", err) | ||
| continue | ||
| } | ||
|
|
||
| allReports = append(allReports, report) | ||
| } | ||
|
|
||
| for _, report := range allReports { | ||
| fmt.Println() | ||
| if txt, err := report.Text(); err != nil { | ||
| slog.Error("error generating text report", "error", err) | ||
| continue | ||
| } else { | ||
| fmt.Println(txt) | ||
| } | ||
| fmt.Println() | ||
| } | ||
|
|
||
| if err := os.MkdirAll("_site", 0755); err != nil && err != os.ErrExist { | ||
| slog.Error("error creating _site/ for HTML report") | ||
| panic(err) | ||
| } | ||
| if err := reports.WriteHTML(allReports, "_site/index.html"); err != nil { | ||
| slog.Error("error rendering HTML template", "err", err) | ||
| os.Exit(1) | ||
| } | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| func init() { | ||
| root.AddCommand(testManyCmd) | ||
| } |
This file contains 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,131 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "time" | ||
|
|
||
| "github.com/TBD54566975/web5-spec/openapi" | ||
| "github.com/TBD54566975/web5-spec/reports" | ||
| "github.com/TBD54566975/web5-spec/tests" | ||
| "github.com/spf13/cobra" | ||
| "golang.org/x/exp/slog" | ||
| ) | ||
|
|
||
| var ( | ||
| testOneCmd = &cobra.Command{ | ||
| Use: "one [dir]", | ||
| Run: func(cmd *cobra.Command, args []string) { | ||
| dir, _ := os.Getwd() | ||
| if len(args) > 0 { | ||
| dir = args[0] | ||
| } | ||
|
|
||
| report, err := testOne(dir) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| fmt.Println() | ||
| if txt, err := report.Text(); err != nil { | ||
| slog.Error("error generating text report", "error", err) | ||
| } else { | ||
| fmt.Println(txt) | ||
| } | ||
| fmt.Println() | ||
|
|
||
| stepSummaryFile := os.Getenv("GITHUB_STEP_SUMMARY") | ||
| if stepSummaryFile != "" { | ||
| if err := reports.WriteMarkdown(report, stepSummaryFile); err != nil { | ||
| slog.Error("error writing github step summary", "file", stepSummaryFile, "error", err) | ||
| } | ||
| } | ||
|
|
||
| if !report.IsPassing() { | ||
| os.Exit(1) | ||
| } | ||
|
|
||
| os.Exit(0) | ||
| }, | ||
| } | ||
| ) | ||
|
|
||
| func testOne(dir string) (reports.Report, error) { | ||
| logger := slog.NewTextHandler(os.Stdout, &slog.HandlerOptions{Level: slog.LevelDebug}) | ||
| slog.SetDefault(slog.New(logger)) | ||
|
|
||
| var dockerfile string | ||
| for _, d := range dockerfiles { | ||
| candidate := filepath.Join(dir, d) | ||
| if _, err := os.Stat(candidate); !os.IsNotExist(err) { | ||
| dockerfile = d | ||
| } | ||
| } | ||
|
|
||
| if dockerfile == "" { | ||
| return reports.Report{}, fmt.Errorf("no dockerfile found (paths=%v)", dockerfiles) | ||
| } | ||
|
|
||
| cmd := docker(dir, "build", "-t", "web5-spec:latest", "-f", dockerfile, ".") | ||
| if err := cmd.Run(); err != nil { | ||
| return reports.Report{}, fmt.Errorf("error building server: %v", err) | ||
| } | ||
|
|
||
| cmd = docker(dir, "run", "-p", "8080:8080", "--name", "web5-spec", "--rm", "web5-spec:latest") | ||
| if err := cmd.Start(); err != nil { | ||
| return reports.Report{}, fmt.Errorf("error running server: %v", err) | ||
| } | ||
|
|
||
| defer func() { | ||
| cmd := docker(dir, "stop", "web5-spec") | ||
| if err := cmd.Run(); err != nil { | ||
| slog.Error("error stopping server container", "error", err) | ||
| } | ||
| }() | ||
|
|
||
| ctx := context.Background() | ||
|
|
||
| client, err := openapi.NewClientWithResponses("http://localhost:8080") | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| var serverID openapi.TestServerID | ||
| for { | ||
| serverIDResponse, err := client.IdentifySelfWithResponse(ctx) | ||
| if err != nil { | ||
| slog.Debug("waiting for server to come up", "err", err) | ||
| time.Sleep(time.Second) | ||
| continue | ||
| } | ||
|
|
||
| if serverIDResponse.JSON200 == nil { | ||
| slog.Debug("server ID check failed, retrying in 1 second", "status", serverIDResponse.Status(), "body", string(serverIDResponse.Body)) | ||
| time.Sleep(time.Second) | ||
| continue | ||
| } | ||
|
|
||
| serverID = *serverIDResponse.JSON200 | ||
| break | ||
| } | ||
|
|
||
| defer func() { | ||
| _, err := client.ServerShutdown(context.Background()) | ||
| if err != nil { | ||
| slog.Error("error shutting down server", "error", err) | ||
| } | ||
| }() | ||
|
|
||
| slog.Debug("server running", "sdk", serverID.Name, "url", serverID.Url) | ||
|
|
||
| return reports.Report{ | ||
| TestServerID: serverID, | ||
| Results: tests.RunTests("http://localhost:8080"), | ||
| }, nil | ||
| } | ||
|
|
||
| func init() { | ||
| root.AddCommand(testOneCmd) | ||
| } |
This file contains 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.