-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
tests: Include tests for
pkg/api
(#138)
* tests: Include UT tests to pkg/api/store Add unit tests for `pkg/api/store` coverage as 84% Signed-off-by: Kairo de Araujo <[email protected]> * tests: Include UT tests to pkg/api/download Add unit tests for `pkg/api/download` coverage as 85% The UT found a bug in the `DownloadWithWriter`. This bug returns nil instead of error and affects users while downloading envelopes. For example, the `archivistactl retrieve envelope` command, if giving an invalid server or if the server is unavailable, will return no error. In the `archivistactl`, the user will behave the same when the server is available, and there is no envelope with the expected `gitoid`. Signed-off-by: Kairo de Araujo <[email protected]> * tests: Include UT tests to pkg/api/graphql Add unit tests for `pkg/api/graphql` coverage as 86% Signed-off-by: Kairo de Araujo <[email protected]> --------- Signed-off-by: Kairo de Araujo <[email protected]>
- Loading branch information
1 parent
e27a40f
commit cabf49d
Showing
5 changed files
with
546 additions
and
3 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
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,172 @@ | ||
// Copyright 2023 The Archivista Contributors | ||
// | ||
// 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 api_test | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"io" | ||
"net/http" | ||
"net/http/httptest" | ||
"os" | ||
"path" | ||
"testing" | ||
|
||
"github.com/in-toto/archivista/pkg/api" | ||
"github.com/in-toto/go-witness/dsse" | ||
"github.com/stretchr/testify/suite" | ||
) | ||
|
||
// Test Suite: UT APIDownload | ||
type UTAPIDownloadSuite struct { | ||
suite.Suite | ||
} | ||
|
||
func TestAPIDownloadSuite(t *testing.T) { | ||
suite.Run(t, new(UTAPIDownloadSuite)) | ||
} | ||
|
||
func (ut *UTAPIDownloadSuite) Test_Download() { | ||
|
||
testEnvelope, err := os.ReadFile("../../test/package.attestation.json") | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
expectedEnvelop := dsse.Envelope{} | ||
err = json.Unmarshal(testEnvelope, &expectedEnvelop) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
|
||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusOK) | ||
_, err = w.Write(testEnvelope) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
ctx := context.TODO() | ||
|
||
// test api.Download happy flow | ||
resp, err := api.Download(ctx, testServer.URL, "gitoid_test") | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
|
||
ut.Equal(expectedEnvelop, resp) | ||
} | ||
|
||
func (ut *UTAPIDownloadSuite) Test_Download_DecodeFailure() { | ||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusOK) | ||
_, err := w.Write([]byte(`invalid`)) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
ctx := context.TODO() | ||
|
||
// test api.Download happy flow | ||
resp, err := api.Download(ctx, testServer.URL, "gitoid_test") | ||
ut.Error(err) | ||
ut.Equal(dsse.Envelope{}, resp) | ||
} | ||
|
||
func (ut *UTAPIDownloadSuite) Test_DownloadWithReader() { | ||
|
||
// mock server | ||
expected := `{"body":"body"}` | ||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusOK) | ||
_, err := w.Write([]byte(expected)) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
|
||
// context | ||
ctx := context.TODO() | ||
|
||
// temporary file | ||
tempDir := os.TempDir() | ||
dst, err := os.Create(path.Join(tempDir, "test")) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
err = api.DownloadWithWriter(ctx, testServer.URL, "gitoid", dst) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
|
||
// validate result | ||
result, err := os.ReadFile(path.Join(tempDir, "test")) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
ut.Equal(expected, string(result)) | ||
} | ||
|
||
func (ut *UTAPIDownloadSuite) Test_DownloadWithWriter_NoServer() { | ||
|
||
// context | ||
ctx := context.TODO() | ||
|
||
// dst as stdout | ||
var dst io.Writer = os.Stdout | ||
|
||
err := api.DownloadWithWriter(ctx, "http://invalid-archivista", "gitoid_test", dst) | ||
ut.Error(err) | ||
} | ||
|
||
func (ut *UTAPIDownloadSuite) Test_DownloadWithWriter_BadStatusCode() { | ||
|
||
// mock server | ||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusInternalServerError) | ||
_, err := w.Write([]byte(`Internal Server Error`)) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
|
||
// dst as stdout | ||
var dst io.Writer = os.Stdout | ||
|
||
// context | ||
ctx := context.TODO() | ||
|
||
err := api.DownloadWithWriter(ctx, testServer.URL, "gitoid_test", dst) | ||
ut.ErrorContains(err, "Internal Server Error") | ||
} |
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,161 @@ | ||
// Copyright 2023 The Archivista Contributors | ||
// | ||
// 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 api_test | ||
|
||
import ( | ||
"context" | ||
"net/http" | ||
"net/http/httptest" | ||
"testing" | ||
|
||
"github.com/in-toto/archivista/pkg/api" | ||
"github.com/stretchr/testify/suite" | ||
) | ||
|
||
// Test Suite: UT APIStore | ||
type UTAPIGraphQLSuite struct { | ||
suite.Suite | ||
} | ||
|
||
func TestAPIGraphQLSuite(t *testing.T) { | ||
suite.Run(t, new(UTAPIGraphQLSuite)) | ||
} | ||
|
||
func (ut *UTAPIGraphQLSuite) Test_Store() { | ||
|
||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusOK) | ||
_, err := w.Write([]byte(`{"data": {"data": "test"}}`)) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
ctx := context.TODO() | ||
|
||
type testSubjectVar struct { | ||
Gitoid string `json:"gitoid"` | ||
} | ||
|
||
type testSubjectResult struct { | ||
Data string `json:"data"` | ||
} | ||
result, err := api.GraphQlQuery[testSubjectResult](ctx, testServer.URL, `query`, testSubjectVar{Gitoid: "test_Gitoid"}) | ||
ut.NoError(err) | ||
ut.Equal(testSubjectResult{Data: "test"}, result) | ||
} | ||
|
||
func (ut *UTAPIGraphQLSuite) Test_Store_NoServer() { | ||
|
||
ctx := context.TODO() | ||
|
||
type testSubjectVar struct { | ||
Gitoid string `json:"gitoid"` | ||
} | ||
|
||
type testSubjectResult struct { | ||
Data string `json:"data"` | ||
} | ||
result, err := api.GraphQlQuery[testSubjectResult](ctx, "http://invalid-archivista", `query`, testSubjectVar{Gitoid: "test_Gitoid"}) | ||
ut.Error(err) | ||
ut.Equal(testSubjectResult{Data: ""}, result) | ||
} | ||
|
||
func (ut *UTAPIGraphQLSuite) Test_Store_BadStatusCode_NoMsg() { | ||
|
||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusInternalServerError) | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
ctx := context.TODO() | ||
|
||
type testSubjectVar struct { | ||
Gitoid string `json:"gitoid"` | ||
} | ||
|
||
type testSubjectResult struct { | ||
Data string `json:"data"` | ||
} | ||
result, err := api.GraphQlQuery[testSubjectResult](ctx, testServer.URL, `query`, testSubjectVar{Gitoid: "test_Gitoid"}) | ||
ut.Error(err) | ||
ut.Equal(testSubjectResult{Data: ""}, result) | ||
} | ||
|
||
func (ut *UTAPIGraphQLSuite) Test_Store_InvalidData() { | ||
|
||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusOK) | ||
_, err := w.Write([]byte(``)) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
ctx := context.TODO() | ||
|
||
type testSubjectVar struct { | ||
Gitoid string `json:"gitoid"` | ||
} | ||
|
||
type testSubjectResult struct { | ||
Data string `json:"data"` | ||
} | ||
result, err := api.GraphQlQuery[testSubjectResult](ctx, testServer.URL, `query`, testSubjectVar{Gitoid: "test_Gitoid"}) | ||
ut.Error(err) | ||
ut.Equal(testSubjectResult{Data: ""}, result) | ||
} | ||
|
||
func (ut *UTAPIGraphQLSuite) Test_Store_QLReponseWithErrors() { | ||
|
||
testServer := httptest.NewServer( | ||
http.HandlerFunc( | ||
func(w http.ResponseWriter, r *http.Request) { | ||
w.WriteHeader(http.StatusOK) | ||
_, err := w.Write([]byte(`{"data": {"data": "test"}, "errors": [{"message": "test_error"}]}}`)) | ||
if err != nil { | ||
ut.FailNow(err.Error()) | ||
} | ||
}, | ||
), | ||
) | ||
defer testServer.Close() | ||
ctx := context.TODO() | ||
|
||
type testSubjectVar struct { | ||
Gitoid string `json:"gitoid"` | ||
} | ||
|
||
type testSubjectResult struct { | ||
Data string `json:"data"` | ||
Errors string `json:"errors"` | ||
} | ||
|
||
result, err := api.GraphQlQuery[testSubjectResult](ctx, testServer.URL, `query`, testSubjectVar{Gitoid: "test_Gitoid"}) | ||
ut.Error(err) | ||
ut.EqualError(err, "graph ql query failed: [{test_error}]") | ||
ut.Equal(testSubjectResult{Data: ""}, result) | ||
} |
Oops, something went wrong.