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.
215 lines
6.5 KiB
Go
215 lines
6.5 KiB
Go
package cmd
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/actions/gh-actions-cache/internal"
|
|
"github.com/actions/gh-actions-cache/types"
|
|
"github.com/stretchr/testify/assert"
|
|
|
|
"gopkg.in/h2non/gock.v1"
|
|
)
|
|
|
|
func TestListWithIncorrectArguments(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"keyValue"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "Invalid argument(s). Expected 0 received 1")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithIncorrectRepo(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--repo", "testOrg/testRepo/123/123"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "expected the \"[HOST/]OWNER/REPO\" format, got \"testOrg/testRepo/123/123\"")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithNegativeLimit(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--limit", "-1", "--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "-1 is not a valid integer value for limit flag. Allowed values: 1-100")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithIncorrectLimit(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--limit", "101", "--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "101 is not a valid integer value for limit flag. Allowed values: 1-100")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListLimitShorthandUsingIncorrectLimit(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"-L", "102", "--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "102 is not a valid integer value for limit flag. Allowed values: 1-100")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithIncorrectOrder(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--order", "incorrectOrderValue", "--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "incorrectOrderValue is not a valid value for order flag. Allowed values: asc/desc")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithIncorrectSort(t *testing.T) {
|
|
t.Cleanup(gock.Off)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--sort", "incorrectSortValue", "--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
assert.ErrorContains(t, err, "incorrectSortValue is not a valid value for sort flag. Allowed values: last-used/size/created-at")
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithIncorrectRepoForListCaches(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": "t-dedah/vipul-bugbash",
|
|
"active_caches_size_in_bytes": 291205,
|
|
"active_caches_count": 12
|
|
}`)
|
|
|
|
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"
|
|
}`)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
var customError types.HandledError
|
|
if assert.ErrorAs(t, err, &customError) {
|
|
assert.Equal(t, "The given repo does not exist.", customError.Message)
|
|
}
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithUnauthorizedRequestForListCaches(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": "t-dedah/vipul-bugbash",
|
|
"active_caches_size_in_bytes": 291205,
|
|
"active_caches_count": 12
|
|
}`)
|
|
|
|
gock.New("https://api.github.com").
|
|
Get("/repos/testOrg/testRepo/actions/caches").
|
|
Reply(401).
|
|
JSON(`{
|
|
"message": "Must have admin rights to Repository.",
|
|
"documentation_url": "https://docs.github.com/rest/actions/cache#delete-a-github-actions-cache-for-a-repository-using-a-cache-id"
|
|
}`)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
var customError types.HandledError
|
|
if assert.ErrorAs(t, err, &customError) {
|
|
assert.Equal(t, "Must have admin rights to Repository.", customError.Message)
|
|
}
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListWithInternalServerErrorForListCaches(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": "t-dedah/vipul-bugbash",
|
|
"active_caches_size_in_bytes": 291205,
|
|
"active_caches_count": 12
|
|
}`)
|
|
|
|
gock.New("https://api.github.com").
|
|
Get("/repos/testOrg/testRepo/actions/caches").
|
|
Reply(500).
|
|
JSON(`{
|
|
"message": "Internal Server Error",
|
|
"documentation_url": "https://docs.github.com/rest/reference/actions#get-github-actions-cache-list-for-a-repository"
|
|
}`)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
var customError types.HandledError
|
|
if assert.ErrorAs(t, err, &customError) {
|
|
assert.Equal(t, "We could not process your request due to internal error.", customError.Message)
|
|
}
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|
|
|
|
func TestListSuccess(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": "t-dedah/vipul-bugbash",
|
|
"active_caches_size_in_bytes": 2432967,
|
|
"active_caches_count": 1
|
|
}`)
|
|
|
|
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
|
|
}]
|
|
}`)
|
|
|
|
cmd := NewCmdList()
|
|
cmd.SetArgs([]string{"--repo", "testOrg/testRepo"})
|
|
err := cmd.Execute()
|
|
|
|
assert.NoError(t, err)
|
|
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
|
|
}
|