airshipctl/pkg/remote/remote_direct_test.go

/*
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     https://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
*/

package remote

import (
	"fmt"
	"testing"

	"github.com/stretchr/testify/assert"

	"opendev.org/airship/airshipctl/pkg/config"
	"opendev.org/airship/airshipctl/pkg/environment"
	"opendev.org/airship/airshipctl/pkg/remote/redfish"
	"opendev.org/airship/airshipctl/testutil/redfishutils"
)

const (
	systemID   = "System.Embedded.1"
	isoURL     = "https://localhost:8080/ubuntu.iso"
	redfishURL = "redfish+https://localhost:2344/Systems/System.Embedded.1"
	username   = "admin"
	password   = "password"
)

// withRemoteDirectConfig initializes the remote direct settings when used as an argument to "initSettings".
func withRemoteDirectConfig(cfg *config.RemoteDirect) Configuration {
	return func(settings *environment.AirshipCTLSettings) {
		bootstrapInfo, err := settings.Config.CurrentContextBootstrapInfo()
		if err != nil {
			panic(fmt.Sprintf("Unable to initialize remote direct tests. Current Context error %q", err))
		}

		bootstrapInfo.RemoteDirect = cfg
	}
}

func TestDoRemoteDirectMissingConfigOpts(t *testing.T) {
	ctx, rMock, err := redfishutils.NewClient(redfishURL, false, false, username, password)
	assert.NoError(t, err)

	ephemeralHost := baremetalHost{
		rMock,
		ctx,
		redfishURL,
		"doc-name",
		username,
		password,
	}

	settings := initSettings(t, withRemoteDirectConfig(nil), withTestDataPath("base"))
	err = ephemeralHost.DoRemoteDirect(settings)
	assert.Error(t, err)
}

func TestDoRemoteDirectMissingISOURL(t *testing.T) {
	ctx, rMock, err := redfishutils.NewClient(redfishURL, false, false, username, password)
	assert.NoError(t, err)

	rMock.On("NodeID").Times(1).Return(systemID)

	ephemeralHost := baremetalHost{
		rMock,
		ctx,
		redfishURL,
		"doc-name",
		username,
		password,
	}

	cfg := &config.RemoteDirect{}

	settings := initSettings(t, withRemoteDirectConfig(cfg), withTestDataPath("base"))
	err = ephemeralHost.DoRemoteDirect(settings)
	assert.Error(t, err)
}

func TestDoRemoteDirectRedfish(t *testing.T) {
	ctx, rMock, err := redfishutils.NewClient(redfishURL, false, false, username, password)
	assert.NoError(t, err)

	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("SetVirtualMedia", ctx, isoURL).Times(1).Return(nil)
	rMock.On("SetBootSourceByType", ctx).Times(1).Return(nil)
	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("RebootSystem", ctx).Times(1).Return(nil)

	ephemeralHost := baremetalHost{
		rMock,
		ctx,
		redfishURL,
		"doc-name",
		username,
		password,
	}

	cfg := &config.RemoteDirect{
		IsoURL: isoURL,
	}

	settings := initSettings(t, withRemoteDirectConfig(cfg), withTestDataPath("base"))
	err = ephemeralHost.DoRemoteDirect(settings)
	assert.NoError(t, err)
}

func TestDoRemoteDirectRedfishVirtualMediaError(t *testing.T) {
	ctx, rMock, err := redfishutils.NewClient(redfishURL, false, false, username, password)
	assert.NoError(t, err)

	expectedErr := redfish.ErrRedfishClient{Message: "Unable to set virtual media."}

	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("SetVirtualMedia", ctx, isoURL).Times(1).Return(expectedErr)
	rMock.On("SetBootSourceByType", ctx).Times(1).Return(nil)
	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("RebootSystem", ctx).Times(1).Return(nil)

	ephemeralHost := baremetalHost{
		rMock,
		ctx,
		redfishURL,
		"doc-name",
		username,
		password,
	}

	cfg := &config.RemoteDirect{
		IsoURL: isoURL,
	}

	settings := initSettings(t, withRemoteDirectConfig(cfg), withTestDataPath("base"))

	err = ephemeralHost.DoRemoteDirect(settings)
	_, ok := err.(redfish.ErrRedfishClient)
	assert.True(t, ok)
}

func TestDoRemoteDirectRedfishBootSourceError(t *testing.T) {
	ctx, rMock, err := redfishutils.NewClient(redfishURL, false, false, username, password)
	assert.NoError(t, err)

	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("SetVirtualMedia", ctx, isoURL).Times(1).Return(nil)

	expectedErr := redfish.ErrRedfishClient{Message: "Unable to set boot source."}
	rMock.On("SetBootSourceByType", ctx).Times(1).Return(expectedErr)
	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("RebootSystem", ctx).Times(1).Return(nil)

	ephemeralHost := baremetalHost{
		rMock,
		ctx,
		redfishURL,
		"doc-name",
		username,
		password,
	}

	cfg := &config.RemoteDirect{
		IsoURL: isoURL,
	}

	settings := initSettings(t, withRemoteDirectConfig(cfg), withTestDataPath("base"))

	err = ephemeralHost.DoRemoteDirect(settings)
	_, ok := err.(redfish.ErrRedfishClient)
	assert.True(t, ok)
}

func TestDoRemoteDirectRedfishRebootError(t *testing.T) {
	ctx, rMock, err := redfishutils.NewClient(redfishURL, false, false, username, password)
	assert.NoError(t, err)

	rMock.On("NodeID").Times(1).Return(systemID)
	rMock.On("SetVirtualMedia", ctx, isoURL).Times(1).Return(nil)
	rMock.On("SetVirtualMedia", ctx, isoURL).Times(1).Return(nil)
	rMock.On("SetBootSourceByType", ctx).Times(1).Return(nil)
	rMock.On("NodeID").Times(1).Return(systemID)

	expectedErr := redfish.ErrRedfishClient{Message: "Unable to set boot source."}
	rMock.On("RebootSystem", ctx).Times(1).Return(expectedErr)

	ephemeralHost := baremetalHost{
		rMock,
		ctx,
		redfishURL,
		"doc-name",
		username,
		password,
	}

	cfg := &config.RemoteDirect{
		IsoURL: isoURL,
	}

	settings := initSettings(t, withRemoteDirectConfig(cfg), withTestDataPath("base"))

	err = ephemeralHost.DoRemoteDirect(settings)
	_, ok := err.(redfish.ErrRedfishClient)
	assert.True(t, ok)
}