client: Add functions to support compose testing
Also adds new types to weldr/json.go to support them. ComposeEntry had to be duplicated instead of used as-is because it enforces image type strings that do not match what the API uses (the API types are all lower case, the internal names are capitalized).
This commit is contained in:
Brian C. Lane
Tom Gundersen
parent
7c86dc533c
commit
f960985c17
3 changed files with 615 additions and 0 deletions
352
internal/client/compose_test.go
Normal file
352
internal/client/compose_test.go
Normal file
|
|
@ -0,0 +1,352 @@
|
|||
// Package client - compose_test contains functions to check the compose API
|
||||
// Copyright (C) 2020 by Red Hat, Inc.
|
||||
|
||||
// Tests should be self-contained and not depend on the state of the server
|
||||
// They should use their own blueprints, not the default blueprints
|
||||
// They should not assume version numbers for packages will match
|
||||
// They should run tests that depend on previous results from the same function
|
||||
// not from other functions.
|
||||
//
|
||||
// NOTE: The compose fail/finish tests use fake composes so the following are not
|
||||
// fully tested here:
|
||||
//
|
||||
// * image download
|
||||
// * log download
|
||||
// * logs archive download
|
||||
//
|
||||
// In addition osbuild-composer has not implemented:
|
||||
//
|
||||
// * compose/results
|
||||
// * compose/metadata
|
||||
package client
|
||||
|
||||
import (
|
||||
"io/ioutil"
|
||||
"net/http"
|
||||
"testing"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/osbuild/osbuild-composer/internal/weldr"
|
||||
)
|
||||
|
||||
// Test the compose types API
|
||||
func TestComposeTypesV0(t *testing.T) {
|
||||
composeTypes, resp, err := GetComposesTypesV0(testState.socket)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.Greater(t, len(composeTypes), 0)
|
||||
var found bool
|
||||
for _, t := range composeTypes {
|
||||
if t.Name == "qcow2" && t.Enabled == true {
|
||||
found = true
|
||||
break
|
||||
}
|
||||
}
|
||||
require.True(t, found, "qcow2 not in list of compose types: %#v", composeTypes)
|
||||
}
|
||||
|
||||
// Test compose with invalid type fails
|
||||
func TestComposeInvalidTypeV0(t *testing.T) {
|
||||
// lorax-composer checks the blueprint name before checking the compose type
|
||||
// so we need to push an empty blueprint to make sure the right failure is checked
|
||||
bp := `
|
||||
name="test-compose-invalid-type-v0"
|
||||
description="TestComposeInvalidTypeV0"
|
||||
version="0.0.1"
|
||||
`
|
||||
resp, err := PostTOMLBlueprintV0(testState.socket, bp)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.True(t, resp.Status, "POST failed: %#v", resp)
|
||||
|
||||
compose := `{
|
||||
"blueprint_name": "test-compose-invalid-type-v0",
|
||||
"compose_type": "snakes",
|
||||
"branch": "master"
|
||||
}`
|
||||
resp, err = PostComposeV0(testState.socket, compose)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.NotNil(t, resp)
|
||||
require.False(t, resp.Status, "POST did not fail")
|
||||
require.Equal(t, len(resp.Errors), 1)
|
||||
require.Contains(t, resp.Errors[0].Msg, "snakes")
|
||||
}
|
||||
|
||||
// Test compose for unknown blueprint fails
|
||||
func TestComposeInvalidBlueprintV0(t *testing.T) {
|
||||
compose := `{
|
||||
"blueprint_name": "test-invalid-bp-compose-v0",
|
||||
"compose_type": "qcow2",
|
||||
"branch": "master"
|
||||
}`
|
||||
resp, err := PostComposeV0(testState.socket, compose)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.NotNil(t, resp)
|
||||
require.False(t, resp.Status, "POST did not fail")
|
||||
require.Equal(t, len(resp.Errors), 1)
|
||||
require.Contains(t, resp.Errors[0].Msg, "test-invalid-bp-compose-v0")
|
||||
}
|
||||
|
||||
// Test compose cancel for unknown uuid fails
|
||||
// Is cancel implemented at all?
|
||||
|
||||
// Test compose delete for unknown uuid
|
||||
func TestDeleteUnknownComposeV0(t *testing.T) {
|
||||
status, resp, err := DeleteComposeV0(testState.socket, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
// TODO -- fix the API Handler in osbuild-composer, should be no uuids
|
||||
assert.Equal(t, 0, len(status.UUIDs), "%#v", status)
|
||||
require.Equal(t, 1, len(status.Errors), "%#v", status)
|
||||
require.Equal(t, "UnknownUUID", status.Errors[0].ID)
|
||||
require.Contains(t, status.Errors[0].Msg, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
}
|
||||
|
||||
// Test compose info for unknown uuid
|
||||
func TestUnknownComposeInfoV0(t *testing.T) {
|
||||
_, resp, err := GetComposeInfoV0(testState.socket, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.NotNil(t, resp)
|
||||
require.False(t, resp.Status)
|
||||
require.Equal(t, 1, len(resp.Errors))
|
||||
require.Equal(t, "UnknownUUID", resp.Errors[0].ID)
|
||||
require.Contains(t, resp.Errors[0].Msg, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
}
|
||||
|
||||
// Test compose metadata for unknown uuid
|
||||
// TODO osbuild-composer has not implemented compose/metadata yet
|
||||
|
||||
// Test compose results for unknown uuid
|
||||
// TODO osbuild-composer has not implemented compose/results yet
|
||||
|
||||
// Test compose image for unknown uuid
|
||||
func TestComposeInvalidImageV0(t *testing.T) {
|
||||
resp, err := WriteComposeImageV0(testState.socket, ioutil.Discard, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.NotNil(t, resp)
|
||||
require.False(t, resp.Status)
|
||||
require.Equal(t, 1, len(resp.Errors))
|
||||
require.Equal(t, "UnknownUUID", resp.Errors[0].ID)
|
||||
require.Contains(t, resp.Errors[0].Msg, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
}
|
||||
|
||||
// Test compose logs for unknown uuid
|
||||
func TestComposeInvalidLogsV0(t *testing.T) {
|
||||
resp, err := WriteComposeLogsV0(testState.socket, ioutil.Discard, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.NotNil(t, resp)
|
||||
require.False(t, resp.Status)
|
||||
require.Equal(t, 1, len(resp.Errors))
|
||||
require.Equal(t, "UnknownUUID", resp.Errors[0].ID)
|
||||
require.Contains(t, resp.Errors[0].Msg, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
}
|
||||
|
||||
// Test compose log for unknown uuid
|
||||
func TestComposeInvalidLogV0(t *testing.T) {
|
||||
resp, err := WriteComposeLogV0(testState.socket, ioutil.Discard, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.NotNil(t, resp)
|
||||
require.False(t, resp.Status)
|
||||
require.Equal(t, 1, len(resp.Errors))
|
||||
require.Equal(t, "UnknownUUID", resp.Errors[0].ID)
|
||||
require.Contains(t, resp.Errors[0].Msg, "c91818f9-8025-47af-89d2-f030d7000c2c")
|
||||
}
|
||||
|
||||
// Test status filter for unknown uuid
|
||||
func TestComposeInvalidStatusV0(t *testing.T) {
|
||||
status, resp, err := GetComposeStatusV0(testState.socket, "c91818f9-8025-47af-89d2-f030d7000c2c", "", "", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.Equal(t, 0, len(status))
|
||||
}
|
||||
|
||||
// Helper for searching compose results for a UUID
|
||||
func UUIDInComposeResults(buildID uuid.UUID, results []weldr.ComposeEntryV0) bool {
|
||||
for idx := range results {
|
||||
if results[idx].ID == buildID {
|
||||
return true
|
||||
}
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
// Helper to wait for a build id to not be in the queue
|
||||
func WaitForBuild(socket *http.Client, buildID uuid.UUID) (*APIResponse, error) {
|
||||
for {
|
||||
queue, resp, err := GetComposeQueueV0(testState.socket)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if resp != nil {
|
||||
return resp, nil
|
||||
}
|
||||
|
||||
if !UUIDInComposeResults(buildID, queue.New) &&
|
||||
!UUIDInComposeResults(buildID, queue.Run) {
|
||||
break
|
||||
}
|
||||
}
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
// Setup and run the failed compose tests
|
||||
func TestFailedComposeV0(t *testing.T) {
|
||||
bp := `
|
||||
name="test-failed-compose-v0"
|
||||
description="TestFailedComposeV0"
|
||||
version="0.0.1"
|
||||
[[packages]]
|
||||
name="bash"
|
||||
version="*"
|
||||
|
||||
[[modules]]
|
||||
name="util-linux"
|
||||
version="*"
|
||||
|
||||
[[customizations.user]]
|
||||
name="root"
|
||||
password="qweqweqwe"
|
||||
`
|
||||
resp, err := PostTOMLBlueprintV0(testState.socket, bp)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.True(t, resp.Status, "POST failed: %#v", resp)
|
||||
|
||||
compose := `{
|
||||
"blueprint_name": "test-failed-compose-v0",
|
||||
"compose_type": "qcow2",
|
||||
"branch": "master"
|
||||
}`
|
||||
// Create a failed test compose
|
||||
body, resp, err := PostJSON(testState.socket, "/api/v1/compose?test=1", compose)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
|
||||
response, err := NewComposeResponseV0(body)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.True(t, response.Status, "POST failed: %#v", response)
|
||||
buildID := response.BuildID
|
||||
|
||||
// Wait until the build is not listed in the queue
|
||||
resp, err = WaitForBuild(testState.socket, buildID)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
|
||||
// Test finished after compose (should not have finished)
|
||||
finished, resp, err := GetFinishedComposesV0(testState.socket)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.False(t, UUIDInComposeResults(buildID, finished))
|
||||
|
||||
// Test failed after compose (should have failed)
|
||||
failed, resp, err := GetFailedComposesV0(testState.socket)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.True(t, UUIDInComposeResults(buildID, failed), "%s not found in failed list: %#v", buildID, failed)
|
||||
|
||||
// Test status filter on failed compose
|
||||
status, resp, err := GetComposeStatusV0(testState.socket, "*", "", "FAILED", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.True(t, UUIDInComposeResults(buildID, status), "%s not found in status list: %#v", buildID, status)
|
||||
|
||||
// Test status of build id
|
||||
status, resp, err = GetComposeStatusV0(testState.socket, buildID.String(), "", "", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.True(t, UUIDInComposeResults(buildID, status), "%s not found in status list: %#v", buildID, status)
|
||||
|
||||
// Test status filter using FINISHED, should not be listed
|
||||
status, resp, err = GetComposeStatusV0(testState.socket, "*", "", "FINISHED", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.False(t, UUIDInComposeResults(buildID, status))
|
||||
|
||||
// Test compose info for the failed compose
|
||||
info, resp, err := GetComposeInfoV0(testState.socket, buildID.String())
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.Equal(t, "FAILED", info.QueueStatus)
|
||||
require.Equal(t, buildID, info.ID)
|
||||
}
|
||||
|
||||
// Setup and run the finished compose tests
|
||||
func TestFinishedComposeV0(t *testing.T) {
|
||||
bp := `
|
||||
name="test-finished-compose-v0"
|
||||
description="TestFinishedComposeV0"
|
||||
version="0.0.1"
|
||||
[[packages]]
|
||||
name="bash"
|
||||
version="*"
|
||||
|
||||
[[modules]]
|
||||
name="util-linux"
|
||||
version="*"
|
||||
|
||||
[[customizations.user]]
|
||||
name="root"
|
||||
password="qweqweqwe"
|
||||
`
|
||||
resp, err := PostTOMLBlueprintV0(testState.socket, bp)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.True(t, resp.Status, "POST failed: %#v", resp)
|
||||
|
||||
compose := `{
|
||||
"blueprint_name": "test-finished-compose-v0",
|
||||
"compose_type": "qcow2",
|
||||
"branch": "master"
|
||||
}`
|
||||
// Create a finished test compose
|
||||
body, resp, err := PostJSON(testState.socket, "/api/v1/compose?test=2", compose)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
|
||||
response, err := NewComposeResponseV0(body)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.True(t, response.Status, "POST failed: %#v", response)
|
||||
buildID := response.BuildID
|
||||
|
||||
// Wait until the build is not listed in the queue
|
||||
resp, err = WaitForBuild(testState.socket, buildID)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
|
||||
// Test failed after compose (should not have failed)
|
||||
failed, resp, err := GetFailedComposesV0(testState.socket)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.False(t, UUIDInComposeResults(buildID, failed))
|
||||
|
||||
// Test finished after compose (should have finished)
|
||||
finished, resp, err := GetFinishedComposesV0(testState.socket)
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.True(t, UUIDInComposeResults(buildID, finished), "%s not found in finished list: %#v", buildID, finished)
|
||||
|
||||
// Test status filter on finished compose
|
||||
status, resp, err := GetComposeStatusV0(testState.socket, "*", "", "FINISHED", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.True(t, UUIDInComposeResults(buildID, status), "%s not found in status list: %#v", buildID, status)
|
||||
|
||||
// Test status of build id
|
||||
status, resp, err = GetComposeStatusV0(testState.socket, buildID.String(), "", "", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.True(t, UUIDInComposeResults(buildID, status), "%s not found in status list: %#v", buildID, status)
|
||||
|
||||
// Test status filter using FAILED, should not be listed
|
||||
status, resp, err = GetComposeStatusV0(testState.socket, "*", "", "FAILED", "")
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.False(t, UUIDInComposeResults(buildID, status))
|
||||
|
||||
// Test compose info for the finished compose
|
||||
info, resp, err := GetComposeInfoV0(testState.socket, buildID.String())
|
||||
require.NoError(t, err, "failed with a client error")
|
||||
require.Nil(t, resp)
|
||||
require.Equal(t, "FINISHED", info.QueueStatus)
|
||||
require.Equal(t, buildID, info.ID)
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue