Files
gh-actions-cache/cmd/delete_test.go
Tom Wieczorek ed34fad2e5 Better testify usage (#54)
* 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.
2023-03-11 22:19:00 +05:30

161 lines
4.7 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 TestDeleteWithIncorrectArguments(t *testing.T) {
t.Cleanup(gock.Off)
cmd := NewCmdDelete()
cmd.SetArgs([]string{})
err := cmd.Execute()
assert.ErrorContains(t, err, "accepts 1 arg(s), received 0")
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
}
func TestDeleteWithIncorrectRepo(t *testing.T) {
t.Cleanup(gock.Off)
cmd := NewCmdDelete()
cmd.SetArgs([]string{"--repo", "testOrg/testRepo/123/123", "cacheName"})
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 TestDeleteWithIncorrectRepoForDeleteCaches(t *testing.T) {
t.Cleanup(gock.Off)
gock.New("https://api.github.com").
Get("/repos/testOrg/testRepo/actions/caches").
MatchParam("key", "cacheName").
Reply(404).
JSON(`{
"message": "Not Found",
"documentation_url": "https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository"
}`)
cmd := NewCmdDelete()
cmd.SetArgs([]string{"--repo", "testOrg/testRepo", "cacheName"})
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 TestDeleteSuccessWithConfirmFlagProvided(t *testing.T) {
t.Cleanup(gock.Off)
gock.New("https://api.github.com").
Delete("/repos/testOrg/testRepo/actions/caches").
MatchParam("key", "2022-06-29T13:33:49").
Reply(200).
JSON(`{
"total_count": 1,
"actions_caches": [
{
"id": 1293,
"ref": "refs/heads/main",
"key": "2022-06-29T13:33:49",
"version": "803758043e242677f6b8650742372d82ded436d99b2a8a09bc3b6ed77cd6aec2",
"last_accessed_at": "2022-06-29T13:33:52.280000000Z",
"created_at": "2022-06-29T13:33:52.280000000Z",
"size_in_bytes": 29747
}
]
}`)
cmd := NewCmdDelete()
cmd.SetArgs([]string{"--repo", "testOrg/testRepo", "2022-06-29T13:33:49", "--confirm"})
err := cmd.Execute()
assert.NoError(t, err)
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
}
func TestDeleteFailureWhileTakingUserInput(t *testing.T) {
t.Cleanup(gock.Off)
choice = "Delete"
gock.New("https://api.github.com").
Get("/repos/testOrg/testRepo/actions/caches").
MatchParam("key", "2022-06-29T13:33:49").
Reply(200).
JSON(`{
"total_count": 1,
"actions_caches": [
{
"id": 1293,
"ref": "refs/heads/main",
"key": "2022-06-29T13:33:49",
"version": "803758043e242677f6b8650742372d82ded436d99b2a8a09bc3b6ed77cd6aec2",
"last_accessed_at": "2022-06-29T13:33:52.280000000Z",
"created_at": "2022-06-29T13:33:52.280000000Z",
"size_in_bytes": 29747
}
]
}`)
cmd := NewCmdDelete()
cmd.SetArgs([]string{"--repo", "testOrg/testRepo", "2022-06-29T13:33:49"})
err := cmd.Execute()
assert.Error(t, err)
assert.True(t, gock.IsDone(), internal.PrintPendingMocks(gock.Pending()))
}
func TestDeleteWithUnauthorizedRequestForDeleteCaches(t *testing.T) {
t.Cleanup(gock.Off)
gock.New("https://api.github.com").
Delete("/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 := NewCmdDelete()
cmd.SetArgs([]string{"--repo", "testOrg/testRepo", "cacheKey", "--confirm"})
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 TestDeleteWithInternalServerErrorForDeleteCaches(t *testing.T) {
t.Cleanup(gock.Off)
gock.New("https://api.github.com").
Delete("/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-Delete-for-a-repository"
}`)
cmd := NewCmdDelete()
cmd.SetArgs([]string{"--repo", "testOrg/testRepo", "cacheKey", "--confirm"})
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()))
}