Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactors create_test.go to use external fixture files #335

Merged
merged 1 commit into from
Aug 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 25 additions & 135 deletions pkg/commands/image/create_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package image_test

import (
"encoding/json"
"os"
"testing"

"github.com/pivotal/kpack/pkg/apis/build/v1alpha2"
Expand Down Expand Up @@ -586,36 +587,10 @@ Image Resource "some-image" created

it("can output in yaml format and does not wait", func() {
require.NoError(t, setLastAppliedAnnotation(expectedImage))
const resourceYAML = `apiVersion: kpack.io/v1alpha2
kind: Image
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: '{"kind":"Image","apiVersion":"kpack.io/v1alpha2","metadata":{"name":"some-image","namespace":"some-default-namespace","creationTimestamp":null},"spec":{"tag":"some-registry.io/some-repo","builder":{"kind":"ClusterBuilder","name":"default"},"serviceAccountName":"default","source":{"git":{"url":"some-git-url","revision":"some-git-rev"},"subPath":"some-sub-path"},"build":{"services":[{"kind":"SomeResource","name":"some-binding","apiVersion":"v1"}],"env":[{"name":"some-key","value":"some-val"}],"resources":{}}},"status":{}}'
creationTimestamp: null
name: some-image
namespace: some-default-namespace
spec:
build:
env:
- name: some-key
value: some-val
resources: {}
services:
- apiVersion: v1
kind: SomeResource
name: some-binding
builder:
kind: ClusterBuilder
name: default
serviceAccountName: default
source:
git:
revision: some-git-rev
url: some-git-url
subPath: some-sub-path
tag: some-registry.io/some-repo
status: {}
`
resourceYAML, err := getTestFile("./testdata/test-image.yaml")
if err != nil {
t.Fatalf("unable to convert test file to string: %v", err)
}

testhelpers.CommandTest{
Args: []string{
Expand All @@ -641,51 +616,10 @@ status: {}

it("can output in json format and does not wait", func() {
require.NoError(t, setLastAppliedAnnotation(expectedImage))
const resourceJSON = `{
"kind": "Image",
"apiVersion": "kpack.io/v1alpha2",
"metadata": {
"name": "some-image",
"namespace": "some-default-namespace",
"creationTimestamp": null,
"annotations": {
"kubectl.kubernetes.io/last-applied-configuration": "{\"kind\":\"Image\",\"apiVersion\":\"kpack.io/v1alpha2\",\"metadata\":{\"name\":\"some-image\",\"namespace\":\"some-default-namespace\",\"creationTimestamp\":null},\"spec\":{\"tag\":\"some-registry.io/some-repo\",\"builder\":{\"kind\":\"ClusterBuilder\",\"name\":\"default\"},\"serviceAccountName\":\"default\",\"source\":{\"git\":{\"url\":\"some-git-url\",\"revision\":\"some-git-rev\"},\"subPath\":\"some-sub-path\"},\"build\":{\"services\":[{\"kind\":\"SomeResource\",\"name\":\"some-binding\",\"apiVersion\":\"v1\"}],\"env\":[{\"name\":\"some-key\",\"value\":\"some-val\"}],\"resources\":{}}},\"status\":{}}"
}
},
"spec": {
"tag": "some-registry.io/some-repo",
"builder": {
"kind": "ClusterBuilder",
"name": "default"
},
"serviceAccountName": "default",
"source": {
"git": {
"url": "some-git-url",
"revision": "some-git-rev"
},
"subPath": "some-sub-path"
},
"build": {
"services": [
{
"kind": "SomeResource",
"name": "some-binding",
"apiVersion": "v1"
}
],
"env": [
{
"name": "some-key",
"value": "some-val"
}
],
"resources": {}
}
},
"status": {}
}
`
resourceJSON, err := getTestFile("./testdata/test-image.json")
if err != nil {
t.Fatalf("unable to convert test file to string: %v", err)
}

testhelpers.CommandTest{
Args: []string{
Expand Down Expand Up @@ -751,36 +685,10 @@ Image Resource "some-image" created (dry run)

when("output flag is used", func() {
it("does not create an image and prints the resource output", func() {
const resourceYAML = `apiVersion: kpack.io/v1alpha2
kind: Image
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: '{"kind":"Image","apiVersion":"kpack.io/v1alpha2","metadata":{"name":"some-image","namespace":"some-default-namespace","creationTimestamp":null},"spec":{"tag":"some-registry.io/some-repo","builder":{"kind":"ClusterBuilder","name":"default"},"serviceAccountName":"default","source":{"git":{"url":"some-git-url","revision":"some-git-rev"},"subPath":"some-sub-path"},"build":{"services":[{"kind":"SomeResource","name":"some-binding","apiVersion":"v1"}],"env":[{"name":"some-key","value":"some-val"}],"resources":{}}},"status":{}}'
creationTimestamp: null
name: some-image
namespace: some-default-namespace
spec:
build:
env:
- name: some-key
value: some-val
resources: {}
services:
- apiVersion: v1
kind: SomeResource
name: some-binding
builder:
kind: ClusterBuilder
name: default
serviceAccountName: default
source:
git:
revision: some-git-rev
url: some-git-url
subPath: some-sub-path
tag: some-registry.io/some-repo
status: {}
`
resourceYAML, err := getTestFile("./testdata/test-image.yaml")
if err != nil {
t.Fatalf("unable to convert test file to string: %v", err)
}

testhelpers.CommandTest{
Args: []string{
Expand Down Expand Up @@ -847,36 +755,10 @@ Image Resource "some-image" created (dry run with image upload)

when("output flag is used", func() {
it("does not create an image and prints the resource output", func() {
const resourceYAML = `apiVersion: kpack.io/v1alpha2
kind: Image
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: '{"kind":"Image","apiVersion":"kpack.io/v1alpha2","metadata":{"name":"some-image","namespace":"some-default-namespace","creationTimestamp":null},"spec":{"tag":"some-registry.io/some-repo","builder":{"kind":"ClusterBuilder","name":"default"},"serviceAccountName":"default","source":{"git":{"url":"some-git-url","revision":"some-git-rev"},"subPath":"some-sub-path"},"build":{"services":[{"kind":"SomeResource","name":"some-binding","apiVersion":"v1"}],"env":[{"name":"some-key","value":"some-val"}],"resources":{}}},"status":{}}'
creationTimestamp: null
name: some-image
namespace: some-default-namespace
spec:
build:
env:
- name: some-key
value: some-val
resources: {}
services:
- apiVersion: v1
kind: SomeResource
name: some-binding
builder:
kind: ClusterBuilder
name: default
serviceAccountName: default
source:
git:
revision: some-git-rev
url: some-git-url
subPath: some-sub-path
tag: some-registry.io/some-repo
status: {}
`
resourceYAML, err := getTestFile("./testdata/test-image.yaml")
if err != nil {
t.Fatalf("unable to convert test file to string: %v", err)
}

testhelpers.CommandTest{
Args: []string{
Expand Down Expand Up @@ -971,3 +853,11 @@ Image Resource "some-image" created
})
}
}

func getTestFile(testfile string) (string, error) {
b, err := os.ReadFile(testfile)
if err != nil {
return "", err
}
return string(b), nil
}
44 changes: 44 additions & 0 deletions pkg/commands/image/testdata/test-image.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"kind": "Image",
"apiVersion": "kpack.io/v1alpha2",
"metadata": {
"name": "some-image",
"namespace": "some-default-namespace",
"creationTimestamp": null,
"annotations": {
"kubectl.kubernetes.io/last-applied-configuration": "{\"kind\":\"Image\",\"apiVersion\":\"kpack.io/v1alpha2\",\"metadata\":{\"name\":\"some-image\",\"namespace\":\"some-default-namespace\",\"creationTimestamp\":null},\"spec\":{\"tag\":\"some-registry.io/some-repo\",\"builder\":{\"kind\":\"ClusterBuilder\",\"name\":\"default\"},\"serviceAccountName\":\"default\",\"source\":{\"git\":{\"url\":\"some-git-url\",\"revision\":\"some-git-rev\"},\"subPath\":\"some-sub-path\"},\"build\":{\"services\":[{\"kind\":\"SomeResource\",\"name\":\"some-binding\",\"apiVersion\":\"v1\"}],\"env\":[{\"name\":\"some-key\",\"value\":\"some-val\"}],\"resources\":{}}},\"status\":{}}"
}
},
"spec": {
"tag": "some-registry.io/some-repo",
"builder": {
"kind": "ClusterBuilder",
"name": "default"
},
"serviceAccountName": "default",
"source": {
"git": {
"url": "some-git-url",
"revision": "some-git-rev"
},
"subPath": "some-sub-path"
},
"build": {
"services": [
{
"kind": "SomeResource",
"name": "some-binding",
"apiVersion": "v1"
}
],
"env": [
{
"name": "some-key",
"value": "some-val"
}
],
"resources": {}
}
},
"status": {}
}
29 changes: 29 additions & 0 deletions pkg/commands/image/testdata/test-image.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
apiVersion: kpack.io/v1alpha2
kind: Image
metadata:
annotations:
kubectl.kubernetes.io/last-applied-configuration: '{"kind":"Image","apiVersion":"kpack.io/v1alpha2","metadata":{"name":"some-image","namespace":"some-default-namespace","creationTimestamp":null},"spec":{"tag":"some-registry.io/some-repo","builder":{"kind":"ClusterBuilder","name":"default"},"serviceAccountName":"default","source":{"git":{"url":"some-git-url","revision":"some-git-rev"},"subPath":"some-sub-path"},"build":{"services":[{"kind":"SomeResource","name":"some-binding","apiVersion":"v1"}],"env":[{"name":"some-key","value":"some-val"}],"resources":{}}},"status":{}}'
creationTimestamp: null
name: some-image
namespace: some-default-namespace
spec:
build:
env:
- name: some-key
value: some-val
resources: {}
services:
- apiVersion: v1
kind: SomeResource
name: some-binding
builder:
kind: ClusterBuilder
name: default
serviceAccountName: default
source:
git:
revision: some-git-rev
url: some-git-url
subPath: some-sub-path
tag: some-registry.io/some-repo
status: {}