add a test for validating access to a node known to ironic

Show that when the host has no Provisioning.ID set we can find the node by name
and we link it to the host by setting the Provisioning.ID field.

Change the CreateNodes() method of the test server to take a callback
so the node "created" by the method can be passed back to the test for
checking.

Only allow POST calls to invoke the handler from CreateNodes().

Unmarshal the input to the CreateNodes() handler and set the UUID in
the node we get instead of changing the JSON string.

Signed-off-by: Doug Hellmann <dhellmann@redhat.com>

Author: dhellmann

pkg/provisioner/ironic/testserver/ironic.go

@@ -1,34 +1,27 @@
 package testserver
 
 import (
+	"encoding/json"
 	"fmt"
 	"io/ioutil"
 	"net/http"
-	"strings"
 	"testing"
 
 	"github.com/gophercloud/gophercloud/openstack/baremetal/v1/nodes"
 )
 
-// CreatedNode holds the body of the request to create the node and
-// the details generated by the server and included in the response.
-type CreatedNode struct {
-	Body string
-	UUID string
-}
-
 // IronicMock is a test server that implements Ironic's semantics
 type IronicMock struct {
 	*MockServer
-	CreatedNodes []CreatedNode
+	CreatedNodes int
 }
 
 // NewIronic builds an ironic mock server
 func NewIronic(t *testing.T) *IronicMock {
 
 	return &IronicMock{
 		MockServer:   New(t, "ironic"),
-		CreatedNodes: nil,
+		CreatedNodes: 0,
 	}
 }
 
@@ -131,9 +124,16 @@ func (m *IronicMock) NodeError(name string, errorCode int) *IronicMock {
 	return m
 }
 
+type CreateNodeCallback func(node nodes.Node)
+
 // CreateNodes configures the server so POSTing to /v1/nodes saves the data
-func (m *IronicMock) CreateNodes() *IronicMock {
+func (m *IronicMock) CreateNodes(callback CreateNodeCallback) *IronicMock {
 	m.Handler("/v1/nodes", func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != http.MethodPost {
+			http.Error(w, fmt.Sprintf("%s not handled for %s", r.Method, r.URL),
+				http.StatusNotImplemented)
+		}
+
 		bodyRaw, err := ioutil.ReadAll(r.Body)
 		if err != nil {
 			m.logRequest(r, fmt.Sprintf("ERROR: %s", err))
@@ -144,25 +144,27 @@ func (m *IronicMock) CreateNodes() *IronicMock {
 		body := string(bodyRaw)
 		m.t.Logf("%s: create nodes request %v", m.name, body)
 
+		// Unpack the input so we can update it
+		node := nodes.Node{}
+		err = json.Unmarshal(bodyRaw, &node)
+		if err != nil {
+			m.logRequest(r, fmt.Sprintf("ERROR: %s", err))
+			http.Error(w, fmt.Sprintf("%s", err), http.StatusInternalServerError)
+			return
+		}
+
 		// The UUID value doesn't actually have to be a UUID, so we
 		// just make a new string based on the count of nodes already
 		// created.
-		uuid := fmt.Sprintf("node-%d", len(m.CreatedNodes))
-		m.t.Logf("%s: uuid %s", m.name, uuid)
-
-		// Record what we have so the test can examine it later
-		m.CreatedNodes = append(m.CreatedNodes, CreatedNode{
-			Body: body,
-			UUID: uuid,
-		})
-
-		// hackily add uuid to the json response by inserting it to the front of the string
-		response := fmt.Sprintf("{\"uuid\": \"%s\", %s", uuid, strings.TrimLeft(body, "{"))
-
-		w.Header().Set("Content-Type", "application/json")
-		w.WriteHeader(http.StatusCreated)
-		fmt.Fprint(w, response)
-		m.logRequest(r, response)
+		node.UUID = fmt.Sprintf("node-%d", m.CreatedNodes)
+		m.t.Logf("%s: uuid %s", m.name, node.UUID)
+		m.CreatedNodes++
+
+		// Pass the data to the test via the callback
+		callback(node)
+
+		// Handle the response to this request
+		m.SendJSONResponse(node, http.StatusCreated, w, r)
 	})
 	return m
 }

pkg/provisioner/ironic/testserver/server.go

@@ -228,3 +228,13 @@ func (m *MockServer) sendData(w http.ResponseWriter, r *http.Request, code int,
 	w.WriteHeader(code)
 	fmt.Fprint(w, payload)
 }
+
+// SendJSONResponse marshalls the payload to a JSON object and sends
+// the response using the given writer
+func (m *MockServer) SendJSONResponse(payload interface{}, code int, w http.ResponseWriter, r *http.Request) {
+	content, err := json.Marshal(payload)
+	if err != nil {
+		m.t.Error(err)
+	}
+	m.sendData(w, r, code, string(content))
+}

pkg/provisioner/ironic/validatemanagementaccess_test.go

@@ -75,7 +75,50 @@ func TestValidateManagementAccessCreateNode(t *testing.T) {
 	host.Spec.BootMACAddress = ""
 	host.Status.Provisioning.ID = "" // so we don't lookup by uuid
 
-	ironic := testserver.NewIronic(t).Ready().CreateNodes().NoNode(host.Name)
+	var createdNode *nodes.Node
+
+	createCallback := func(node nodes.Node) {
+		createdNode = &node
+	}
+
+	ironic := testserver.NewIronic(t).Ready().CreateNodes(createCallback).NoNode(host.Name)
+	ironic.Start()
+	defer ironic.Stop()
+
+	auth := clients.AuthConfig{Type: clients.NoAuth}
+	prov, err := newProvisionerWithSettings(host, bmc.Credentials{}, nullEventPublisher,
+		ironic.Endpoint(), auth, testserver.NewInspector(t).Endpoint(), auth,
+	)
+	if err != nil {
+		t.Fatalf("could not create provisioner: %s", err)
+	}
+
+	result, err := prov.ValidateManagementAccess(false)
+	if err != nil {
+		t.Fatalf("error from ValidateManagementAccess: %s", err)
+	}
+	assert.Equal(t, "", result.ErrorMessage)
+	assert.NotEqual(t, "", createdNode.UUID)
+	assert.Equal(t, createdNode.UUID, host.Status.Provisioning.ID)
+}
+
+func TestValidateManagementAccessExistingNode(t *testing.T) {
+	// Create a host without a bootMACAddress and with a BMC that
+	// does not require one.
+	host := makeHost()
+	host.Spec.BootMACAddress = ""
+	host.Status.Provisioning.ID = "" // so we don't lookup by uuid
+
+	var createdNode *nodes.Node
+
+	createCallback := func(node nodes.Node) {
+		createdNode = &node
+	}
+
+	ironic := testserver.NewIronic(t).Ready().CreateNodes(createCallback).Node(nodes.Node{
+		Name: host.Name,
+		UUID: "uuid",
+	})
 	ironic.Start()
 	defer ironic.Stop()
 
@@ -92,6 +135,7 @@ func TestValidateManagementAccessCreateNode(t *testing.T) {
 		t.Fatalf("error from ValidateManagementAccess: %s", err)
 	}
 	assert.Equal(t, "", result.ErrorMessage)
-	assert.NotEqual(t, "", host.Status.Provisioning.ID)
-	assert.Equal(t, ironic.CreatedNodes[0].UUID, host.Status.Provisioning.ID)
+	assert.Equal(t, "uuid", host.Status.Provisioning.ID)
+	// no node should have been created
+	assert.Nil(t, createdNode)
 }