feat: turn entrypoint into gateway-conformance CLI #15
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
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 |
|---|---|---|
|
|
@@ -3,6 +3,7 @@ | |
| /fixtures.car | ||
| /merge-fixtures | ||
| /entrypoint | ||
| /gateway-conformance | ||
|
|
||
| # Logs | ||
| logs | ||
|
|
||
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 |
|---|---|---|
| @@ -1,13 +1,11 @@ | ||
| FROM golang:1.20-alpine | ||
| WORKDIR /app | ||
| ENV GATEWAY_CONFORMANCE_HOME=/app | ||
|
|
||
| COPY ./go.mod ./go.sum ./ | ||
| RUN go mod download | ||
|
|
||
| COPY . . | ||
| RUN go build -o ./gateway-conformance ./cmd/gateway-conformance | ||
|
|
||
| ENTRYPOINT ["/app/gateway-conformance"] |
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,191 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "fmt" | ||
| "io" | ||
| "log" | ||
| "os" | ||
| "os/exec" | ||
| "path/filepath" | ||
| "strings" | ||
|
|
||
| "github.com/ipfs/gateway-conformance/tooling" | ||
| "github.com/ipfs/gateway-conformance/tooling/car" | ||
| "github.com/ipfs/gateway-conformance/tooling/fixtures" | ||
| "github.com/urfave/cli/v2" | ||
| ) | ||
|
|
||
| type event struct { | ||
| Action string | ||
| Test string `json:",omitempty"` | ||
| } | ||
|
|
||
| type out struct { | ||
| Writer io.Writer | ||
| } | ||
|
|
||
| func (o out) Write(p []byte) (n int, err error) { | ||
| os.Stdout.Write(p) | ||
| return o.Writer.Write(p) | ||
| } | ||
|
|
||
| func copyFiles(inputPaths []string, outputDirectoryPath string) error { | ||
| err := os.MkdirAll(outputDirectoryPath, 0755) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| for _, inputPath := range inputPaths { | ||
| outputPath := filepath.Join(outputDirectoryPath, filepath.Base(inputPath)) | ||
| src, err := os.Open(inputPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer src.Close() | ||
| dst, err := os.Create(outputPath) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer dst.Close() | ||
| _, err = io.Copy(dst, src) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func main() { | ||
| var gatewayURL string | ||
| var jsonOutput string | ||
| var specs string | ||
| var directory string | ||
| var merged bool | ||
|
|
||
| app := &cli.App{ | ||
| Name: "gateway-conformance", | ||
| Usage: "Tooling for the gateway test suite", | ||
| Commands: []*cli.Command{ | ||
| { | ||
| Name: "test", | ||
| Aliases: []string{"t"}, | ||
| Usage: "Run the conformance test suite against your gateway", | ||
| Flags: []cli.Flag{ | ||
| &cli.StringFlag{ | ||
| Name: "gateway-url", | ||
| Aliases: []string{"url", "g"}, | ||
| Usage: "The URL of the gateway to test", | ||
| Value: "http://localhost:8080", | ||
| Destination: &gatewayURL, | ||
| }, | ||
| &cli.StringFlag{ | ||
| Name: "json-output", | ||
| Aliases: []string{"json", "j"}, | ||
| Usage: "The path to the JSON output file", | ||
| Value: "", | ||
| Destination: &jsonOutput, | ||
| }, | ||
| &cli.StringFlag{ | ||
| Name: "specs", | ||
| Usage: "A comma-separated list of specs to test", | ||
| Value: "", | ||
| Destination: &specs, | ||
|
There was a problem hiding this comment. I thought about it and I think I'd prefer an interface that people can get used to. If we have separate flag for each spec (as it was here before), then we'd have to change that interface every time a new spec is added to the tests. I think it'd become quite overwhelming with the amount of different specs we might want to support. Also, it'd be harder to maintain as we'd have to remember to update the lists in all these places. In my opinion a single (or three) flags that take a list of specs will be easier to manage in a long run. There was a problem hiding this comment. It might be useful to add a command for listing all the specs! |
||
| }, | ||
| }, | ||
| Action: func(cCtx *cli.Context) error { | ||
| args := []string{"test", "./tests", "-test.v=test2json"} | ||
|
|
||
| if specs != "" { | ||
| args = append(args, fmt.Sprintf("-specs=%s", specs)) | ||
| } | ||
|
|
||
| args = append(args, cCtx.Args().Slice()...) | ||
|
|
||
| fmt.Println("go " + strings.Join(args, " ")) | ||
|
|
||
| output := &bytes.Buffer{} | ||
| cmd := exec.Command("go", args...) | ||
| cmd.Dir = tooling.Home() | ||
| cmd.Env = append(os.Environ(), fmt.Sprintf("GATEWAY_URL=%s", gatewayURL)) | ||
| cmd.Stdout = out{output} | ||
| cmd.Stderr = os.Stderr | ||
| testErr := cmd.Run() | ||
|
|
||
| if jsonOutput != "" { | ||
| json := &bytes.Buffer{} | ||
| cmd = exec.Command("go", "tool", "test2json", "-p", "Gateway Tests", "-t") | ||
| cmd.Stdin = output | ||
| cmd.Stdout = json | ||
| cmd.Stderr = os.Stderr | ||
| err := cmd.Run() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| // write jsonOutput to json file | ||
| f, err := os.Create(jsonOutput) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| defer f.Close() | ||
| _, err = f.Write(json.Bytes()) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return testErr | ||
| }, | ||
| }, | ||
| { | ||
| Name: "extract-fixtures", | ||
| Aliases: []string{"e"}, | ||
| Usage: "Extract gateway testing fixtures that are used by the conformance test suite", | ||
| Flags: []cli.Flag{ | ||
| &cli.StringFlag{ | ||
| Name: "directory", | ||
| Aliases: []string{"dir"}, | ||
| Usage: "The directory to extract the fixtures to", | ||
| Required: true, | ||
| Destination: &directory, | ||
| }, | ||
| &cli.BoolFlag{ | ||
| Name: "merged", | ||
| Usage: "Merge the fixtures into a single CAR file", | ||
| Value: false, | ||
| Destination: &merged, | ||
| }, | ||
| }, | ||
| Action: func(cCtx *cli.Context) error { | ||
| err := os.MkdirAll(directory, 0755) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| files, err := fixtures.List() | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| merged := cCtx.Bool("merged") | ||
| if merged { | ||
| err = car.Merge(files, filepath.Join(directory, "fixtures.car")) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } else { | ||
| err = copyFiles(files, directory) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| return nil | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| if err := app.Run(os.Args); err != nil { | ||
| log.Fatal(err) | ||
| } | ||
| } | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disabled it by test name here. I think it's still useful in a case like this. Kubo does support CARs so it wouldn't make sense to disable testing CAR spec altogether. All we want is to disable this single test because Kubo's implementation is wrong at the moment.