ed34fad2e5
* Use assert.NoError instead of assert.Nil
This gives nicer error messages.
* Swap arguments to assert.Equal
The expectation comes first. Otherwise, error messages will be
misleading.
An example:
=== RUN TestDeleteWithIncorrectRepoForDeleteCaches
Error: authentication token not found for host github.com
delete_test.go:56:
Error Trace: /build/source/cmd/delete_test.go:56
Error: Should be true
Test: TestDeleteWithIncorrectRepoForDeleteCaches
Messages: 1 unmatched mocks: https://api.github.com/repos/testOrg/testRepo/actions/caches?key=cacheName
delete_test.go:59:
Error Trace: /build/source/cmd/delete_test.go:59
Error: Not equal:
expected: "authentication token not found for host github.com"
actual : "The given repo does not exist."
Diff:
--- Expected
+++ Actual
@@ -1 +1 @@
-authentication token not found for host github.com
+The given repo does not exist.
Test: TestDeleteWithIncorrectRepoForDeleteCaches
--- FAIL: TestDeleteWithIncorrectRepoForDeleteCaches (0.00s)
* Use assert.Error instead of assert.NotNil
This gives nicer error messages.
* Use assert.ErrorAs and assert.ErrorContains
This simplifies the assertions and potentially gives better error
messages.
* Use require instead of assert and use assert.NotNil as guard
This is to prevent panics in tests, when things get accessed which
shouldn't be nil.
205 lines
6.3 KiB
Go
205 lines
6.3 KiB
Go
package service
|
|
|
|
import (
|
|
"net/url"
|
|
"testing"
|
|
|
|
"github.com/actions/gh-actions-cache/internal"
|
|
"github.com/actions/gh-actions-cache/types"
|
|
"github.com/cli/go-gh/pkg/api"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"gopkg.in/h2non/gock.v1"
|
|
)
|
|
|
|
const VERSION string = "1.0.0"
|
|
|
|
func TestGetCacheUsage_CorrectRepo(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
gock.New("https://api.github.com").
|
|
Get("/repos/testOrg/testRepo/actions/cache/usage").
|
|
Reply(200).
|
|
JSON(`{
|
|
"full_name": "testOrg/testRepo",
|
|
"active_caches_size_in_bytes": 291205,
|
|
"active_caches_count": 12
|
|
}`)
|
|
|
|
repo, err := internal.GetRepo("testOrg/testRepo")
|
|
require.NoError(t, err)
|
|
|
|
artifactCache, err := NewArtifactCache(repo, "list", VERSION)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, artifactCache)
|
|
totalCacheSize, err := artifactCache.GetCacheUsage()
|
|
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, float64(291205), totalCacheSize)
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestGetCacheUsage_IncorrectRepo(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
gock.New("https://api.github.com").
|
|
Get("/repos/testOrg/wrongRepo/actions/cache/usage").
|
|
Reply(404).
|
|
JSON(`{
|
|
"message": "Not Found",
|
|
"documentation_url": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-usage-for-a-repository"
|
|
}`)
|
|
|
|
repo, err := internal.GetRepo("testOrg/wrongRepo")
|
|
require.NoError(t, err)
|
|
|
|
artifactCache, err := NewArtifactCache(repo, "list", VERSION)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, artifactCache)
|
|
totalCacheSize, err := artifactCache.GetCacheUsage()
|
|
var httpError api.HTTPError
|
|
if assert.ErrorAs(t, err, &httpError) {
|
|
assert.Equal(t, 404, httpError.StatusCode)
|
|
assert.Equal(t, "Not Found", httpError.Message)
|
|
}
|
|
assert.Equal(t, float64(-1), totalCacheSize)
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListCaches_Success(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
gock.New("https://api.github.com").
|
|
Get("/repos/testOrg/testRepo/actions/caches").
|
|
Reply(200).
|
|
JSON(`{
|
|
"total_count": 1,
|
|
"actions_caches": [
|
|
{
|
|
"id": 29,
|
|
"ref": "refs/heads/master",
|
|
"key": "Linux-build-cache-node-modules-3fd22dd3a926d576e2562e8b76a5ff157cd3b986f3d44195acfe7efa6bc05919-8",
|
|
"version": "7fcda33c1e1d849a13bcc06f49b9ab64efc01ca9dabe4d7a8d0d387feef4fc88",
|
|
"last_accessed_at": "2022-06-22T20:32:45.550000000Z",
|
|
"created_at": "2022-06-22T20:32:45.550000000Z",
|
|
"size_in_bytes": 2432967
|
|
}]
|
|
}`)
|
|
|
|
repo, err := internal.GetRepo("testOrg/testRepo")
|
|
require.NoError(t, err)
|
|
|
|
f := types.ListOptions{BaseOptions: types.BaseOptions{Repo: "testOrg/testRepo"}, Limit: 30}
|
|
queryParams := url.Values{}
|
|
f.GenerateQueryParams(queryParams)
|
|
|
|
artifactCache, err := NewArtifactCache(repo, "list", VERSION)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, artifactCache)
|
|
listCacheResponse, err := artifactCache.ListCaches(queryParams)
|
|
|
|
assert.NoError(t, err)
|
|
if assert.NotNil(t, listCacheResponse) {
|
|
assert.Equal(t, 1, listCacheResponse.TotalCount)
|
|
assert.Equal(t, 1, len(listCacheResponse.ActionsCaches))
|
|
assert.Equal(t, 29, listCacheResponse.ActionsCaches[0].Id)
|
|
}
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListCaches_Failure(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
gock.New("https://api.github.com").
|
|
Get("/repos/testOrg/testRepo/actions/caches").
|
|
Reply(404).
|
|
JSON(`{
|
|
"message": "Not Found",
|
|
"documentation_url": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-list-for-a-repository"
|
|
}`)
|
|
|
|
repo, err := internal.GetRepo("testOrg/testRepo")
|
|
require.NoError(t, err)
|
|
|
|
f := types.ListOptions{BaseOptions: types.BaseOptions{Repo: "testOrg/testRepo"}, Limit: 30}
|
|
queryParams := url.Values{}
|
|
f.GenerateQueryParams(queryParams)
|
|
|
|
artifactCache, err := NewArtifactCache(repo, "list", VERSION)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, artifactCache)
|
|
listCacheResponse, err := artifactCache.ListCaches(queryParams)
|
|
var httpError api.HTTPError
|
|
if assert.ErrorAs(t, err, &httpError) {
|
|
assert.Equal(t, 404, httpError.StatusCode)
|
|
assert.Equal(t, "Not Found", httpError.Message)
|
|
}
|
|
assert.Equal(t, types.ListApiResponse{}, listCacheResponse)
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestDeleteCaches_Success(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
gock.New("https://api.github.com").
|
|
Delete("/repos/testOrg/testRepo/actions/caches").
|
|
Reply(200).
|
|
JSON(`{
|
|
"total_count": 1,
|
|
"actions_caches": [
|
|
{
|
|
"id": 29,
|
|
"ref": "refs/heads/master",
|
|
"key": "Linux-build-cache-node-modules-3fd22dd3a926d576e2562e8b76a5ff157cd3b986f3d44195acfe7efa6bc05919-8",
|
|
"version": "7fcda33c1e1d849a13bcc06f49b9ab64efc01ca9dabe4d7a8d0d387feef4fc88",
|
|
"last_accessed_at": "2022-06-22T20:32:45.550000000Z",
|
|
"created_at": "2022-06-22T20:32:45.550000000Z",
|
|
"size_in_bytes": 2432967
|
|
}]
|
|
}`)
|
|
|
|
repo, err := internal.GetRepo("testOrg/testRepo")
|
|
require.NoError(t, err)
|
|
|
|
f := types.DeleteOptions{BaseOptions: types.BaseOptions{Repo: "testOrg/testRepo"}}
|
|
queryParams := url.Values{}
|
|
f.GenerateBaseQueryParams(queryParams)
|
|
|
|
artifactCache, err := NewArtifactCache(repo, "delete", VERSION)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, artifactCache)
|
|
deletedCache, err := artifactCache.DeleteCaches(queryParams)
|
|
|
|
assert.NoError(t, err)
|
|
assert.Equal(t, 1, deletedCache)
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestDeleteCaches_Failure(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
gock.New("https://api.github.com").
|
|
Delete("/repos/testOrg/testRepo/actions/caches").
|
|
Reply(404).
|
|
JSON(`{
|
|
"message": "Not Found",
|
|
"documentation_url": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-list-for-a-repository"
|
|
}`)
|
|
|
|
repo, err := internal.GetRepo("testOrg/testRepo")
|
|
require.NoError(t, err)
|
|
|
|
f := types.DeleteOptions{BaseOptions: types.BaseOptions{Repo: "testOrg/testRepo"}}
|
|
queryParams := url.Values{}
|
|
f.GenerateBaseQueryParams(queryParams)
|
|
|
|
artifactCache, err := NewArtifactCache(repo, "delete", VERSION)
|
|
require.NoError(t, err)
|
|
require.NotNil(t, artifactCache)
|
|
deletedCache, err := artifactCache.DeleteCaches(queryParams)
|
|
|
|
assert.Error(t, err)
|
|
assert.Equal(t, 0, deletedCache)
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|