// Package client contains functions for communicating with the API server // Copyright (C) 2020 by Red Hat, Inc. package client import ( "errors" "io/ioutil" "log" "net" "net/http" "os" "strings" "testing" test_distro "github.com/osbuild/osbuild-composer/internal/distro/fedoratest" rpmmd_mock "github.com/osbuild/osbuild-composer/internal/mocks/rpmmd" "github.com/osbuild/osbuild-composer/internal/weldr" "github.com/google/go-cmp/cmp" ) // socketPath is the path to the temporary unix domain socket var socketPath string func TestRequest(t *testing.T) { // Make a request to the status route resp, err := Request(socketPath, "GET", "/api/status", "", map[string]string{}) if err != nil { t.Fatalf("Request good route failed: %v", err) } if resp.StatusCode != 200 { t.Fatalf("Request good route: %d != 200", resp.StatusCode) } // Make a request to a bad route resp, err = Request(socketPath, "GET", "/invalidroute", "", map[string]string{}) if err != nil { t.Fatalf("Request bad route failed: %v", err) } if resp.StatusCode != http.StatusNotFound { t.Fatalf("Request bad route: %d != 404", resp.StatusCode) } // Test that apiError returns ClientError when trying to parse non-JSON response aerr := apiError(resp) if aerr.Status != false { t.Fatalf("apiError of 404 status is != false: %#v", aerr) } if len(aerr.AllErrors()) < 1 { t.Fatalf("apiError of 404 did not return error message: %#v", aerr) } else if aerr.Errors[0].ID != "ClientError" { t.Fatalf("apiError of 404 ID is not ClientError: %#v", aerr) } // Make a request with a bad offset to trigger a JSON response with Status set to 400 resp, err = Request(socketPath, "GET", "/api/v0/blueprints/list?offset=bad", "", map[string]string{}) if err != nil { t.Fatalf("Request bad offset failed: %v", err) } if resp.StatusCode != http.StatusBadRequest { t.Fatalf("Request bad offset: %d != 400", resp.StatusCode) } } func TestAPIErrorMsg(t *testing.T) { err := APIErrorMsg{ID: "ERROR_ID", Msg: "Meaningful error message"} if diff := cmp.Diff(err.String(), "ERROR_ID: Meaningful error message"); diff != "" { t.Fatalf("APIErrorMsg: %s", diff) } } func TestAPIResponse(t *testing.T) { resp := APIResponse{Status: true} if resp.Error() != "" { t.Fatalf("Empty APIResponse Errors doesn't return empty string: %v", resp.Error()) } resp = APIResponse{Status: false, Errors: []APIErrorMsg{ {ID: "ONE_ERROR", Msg: "First message"}, {ID: "TWO_ERROR", Msg: "Second message"}}, } if diff := cmp.Diff(resp.Error(), "ONE_ERROR: First message"); diff != "" { t.Fatalf("APIResponse.Error: %s", diff) } if diff := cmp.Diff(resp.AllErrors(), []string{"ONE_ERROR: First message", "TWO_ERROR: Second message"}); diff != "" { t.Fatalf("APIErrorMsg: %s", diff) } } func TestClientError(t *testing.T) { err := errors.New("a local client error happened") cerr := clientError(err) if cerr.Status != false { t.Fatal("clientError status != false") } if diff := cmp.Diff(cerr.Error(), "ClientError: a local client error happened"); diff != "" { t.Fatalf("clientError message failed: %s", diff) } } func TestGetRaw(t *testing.T) { // Get raw data b, err := GetRaw(socketPath, "GET", "/api/status") if err != nil { t.Fatalf("GetRaw failed: %v", err) } if len(b) == 0 { t.Fatal("GetRaw returned an empty string") } // Get an API error b, err = GetRaw(socketPath, "GET", "/api/v0/blueprints/list?offset=bad") if err == nil { t.Fatalf("GetRaw error request did not return an error: %v", b) } if err.Status != false { t.Fatalf("Status != false: %#v", err) } if len(err.AllErrors()) < 1 { t.Fatalf("GetRaw error did not return error message: %#v", err) } else if err.Errors[0].ID != "BadLimitOrOffset" { t.Fatalf("GetRaw error ID is not BadLimitOrOffset: %#v", err) } } func TestGetJSONAll(t *testing.T) { // Get all the projects b, err := GetJSONAll(socketPath, "/api/v0/projects/list") if err != nil { t.Fatalf("GetJSONAll failed: %v", err) } if len(b) < 100 { t.Fatalf("GetJSONAll response is too short: %#v", b) } // Run it on a route that doesn't support offset/limit b, err = GetJSONAll(socketPath, "/api/status") if err == nil { t.Fatalf("GetJSONAll bad route failed: %v", b) } if err.Error() != "ClientError: Response is missing the total value" { t.Fatalf("GetJSONAll bad route has unexpected total value: %v", err) } } func TestPostRaw(t *testing.T) { // There are no routes that accept raw POST w/o Content-Type so this ends up testing the error path b, err := PostRaw(socketPath, "/api/v0/blueprints/new", "nobody", nil) if err == nil { t.Fatalf("PostRaw bad request did not return an error: %v", b) } if err.Status != false { t.Fatalf("PostRaw bad request status != false: %#v", err) } if len(err.AllErrors()) < 1 { t.Fatalf("GetRaw error did not return error message: %#v", err) } else if err.Errors[0].ID != "BlueprintsError" { t.Fatalf("GetRaw error ID is not BlueprintsError: %#v", err) } } func TestPostTOML(t *testing.T) { blueprint := `name = "test-blueprint" description = "TOML test blueprint" version = "0.0.1"` b, err := PostTOML(socketPath, "/api/v0/blueprints/new", blueprint) if err != nil { t.Fatalf("PostTOML failed: %v", err) } if !strings.Contains(string(b), "true") { t.Fatalf("PostTOML failed: %#v", string(b)) } } func TestPostJSON(t *testing.T) { blueprint := `{"name": "test-blueprint", "description": "JSON test blueprint", "version": "0.0.1"}` b, err := PostJSON(socketPath, "/api/v0/blueprints/new", blueprint) if err != nil { t.Fatalf("PostJSON failed: %v", err) } if !strings.Contains(string(b), "true") { t.Fatalf("PostJSON failed: %#v", string(b)) } } func TestMain(m *testing.M) { // Setup the mocked server running on a temporary domain socket tmpdir, err := ioutil.TempDir("", "client_test-") if err != nil { panic(err) } defer os.RemoveAll(tmpdir) socketPath = tmpdir + "/client_test.socket" ln, err := net.Listen("unix", socketPath) if err != nil { panic(err) } // Create a mock API server listening on the temporary socket fixture := rpmmd_mock.BaseFixture() rpm := rpmmd_mock.NewRPMMDMock(fixture) distro := test_distro.New() logger := log.New(os.Stdout, "", 0) api := weldr.New(rpm, "test_arch", distro, logger, fixture.Store) server := http.Server{Handler: api} defer server.Close() go func() { server.Serve(ln) }() // Run the tests os.Exit(m.Run()) }