Unit tests for Notebook Instance (#83)

#82 is required for this PR.
This pull request has unit tests for the Notebook Instance, currently it has about 75% coverage and it takes about 0.1 seconds to run.

Here are all the tests:
Create:
- Create=InvalidInput - Given one of the parameters is invalid, ko.Status shows a terminal condition
- Create=Valid - Testing a successful create call

ReadOne:
- ReadOne=AfterCreate - Testing readOne right after create, the status should be in Pending with Resource synced being false.
- ReadOne=Deleting - Testing readOne when deleting, resource synced should be false.
- ReadOne=Fail - Testing readone when Describe fails, an error should be returned.
- ReadOne=FailedState - Testing how readone handles the Failed State, it should have a failure reason.
- ReadOne=InService - Testing how readone handles the InService state. Resource Synced should be true.
- ReadOne=StoppedAfterUpdateACK - Testing how readone handles the Stopped state after it's been updated. In this test the Notebook Instance has been stopped by the controller.
- ReadOne=StoppedAfterUpdateHuman - Testing how readone handles the Stopped state when stopped by a human for an update, StoppedByControllerMeta should not be in the status.
- ReadOne=StoppedBeforeUpdateACK - Testing how readone handles the Stopped state when it's stopped right before an update. The StoppedByControllerMetadata status should be in UpdatePending.
- ReadOne=StoppingDeleting - Testing how readone handles the Stopping state before going into deleting. The Resource synced condition should be set to False.
- ReadOne=StoppingUpdate - Testing how readone handles the Stopping state before going into Update. The resource synced condition should be False and the StoppedByControllerMetadata status should be set to UpdatePending.
- ReadOne=UpdatingUser - Testing how readone handles the Updating status when a user stops the Notebook. StoppedByControllerMetadata should not be in the status field.
- ReadOne=UpdatingUserStopping- Testing if the readone call updates the Notebook's status from stopped to updating, when it recieves information from the server.
- ReadOne=StartFail - Testing how readone would behave if start failed, test should return an error.

Update:
- Update=Pending - This test checks if the Notebook requeues while in Pending state.
- Update=Stopping - This test checks if the Notebook requeues while in Stopping state.
- Update=Updating - This test checks if the Notebook requeues while in updating state.
- Update=InService - This test checks if the controller stops the Notebook. Note: Although a stop controller call has been made runtime has not performed an sdk.Find() as a result the NotebookInstanceStatus will be InService.
- Update=Stopped - ByControllerUser - This test checks if the controller updates and does not set the StoppedByControllerMetadata status.
- Update=InvalidInput - This test checks what the controller would do if update failed. It should return an error.
- Update=Dissassociated - This test checks if the dissassociated parameters are being handled right.
- Update=StopError - This test checks if the controller returns an error if StopNotebookInstance fails.

Delete:
- Delete=InService - This test checks if the Notebook stops before deleting.
- Delete=Deleting - This test checks if the Notebook requeues while deleting
- Delete=Pending - This test checks if the Notebook requeues while in pending state
- Delete=Stopping - This test checks if the Notebook requeues while stopping
- Delete=Updating - This test checks if the Notebook requeues while updating.
- Delete=Stopped - This test checks if the Notebook requeues right after making the delete call.
- Delete=Fail - This test checks if the Notebook returns an error if delete fails.
- Delete=StopFail - This test checks if the Notebook returns an error if delete fails.

Nomenclature:
For readone/delete/update output
nb_(operation)__(suffix)
For update input:
nb_update_<desired/latest>_(suffix)

Directory structure:
testdata
  - v1alpha - (folder which has yaml files)
    -  crud operation
       - desired (folder which has input yaml files)
       - observed (folder which has output yaml files)
  - sdkapi
     - readOne - (server responses for readone)
     - create - (server responses for create) 

TODO: 

ReadOne
Replace status with annotation in the following files:
  - testdata/v1alpha1/readone/desired/nb_readone_stopped_after_update_ack.yaml
  - testdata/v1alpha1/readone/desired/nb_readone_stopped_before_update_ack.yaml
  - testdata/v1alpha1/readone/desired/nb_readone_stopping_update.yaml
  - testdata/v1alpha1/readone/observed/nb_readone_stopped_before_update_ack.yaml
  - testdata/v1alpha1/readone/observed/nb_readone_stopped_before_update_ack.yaml
  - testdata/v1alpha1/readone/observed/nb_readone_stopping_update.yaml

Update tests:
Replace status with annotation in the following files:
  - testdata/v1alpha1/update/desired/nb_update_latest_stopped_controller_input.yaml
  - testdata/v1alpha1/update/desired/nb_update_latest_stopped_dissassociated.yaml
  - testdata/v1alpha1/update/desired/nb_update_latest_stopping_input.yaml
  - testdata/v1alpha1/update/observed/nb_update_inservice.yaml
  - testdata/v1alpha1/update/observed/nb_update_stopped_controller.yaml

Delete tests:
Add tests for complete deletion(once unit test supports that)

Author: ananth102

pkg/resource/notebook_instance/manager_test_suite_test.go

@@ -0,0 +1,137 @@
+// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License"). You may
+// not use this file except in compliance with the License. A copy of the
+// License is located at
+//
+//     http://aws.amazon.com/apache2.0/
+//
+// or in the "license" file accompanying this file. This file 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 notebook_instance
+
+import (
+	"errors"
+	"fmt"
+
+	"path/filepath"
+	"testing"
+
+	ackv1alpha1 "github.com/aws-controllers-k8s/runtime/apis/core/v1alpha1"
+	ackmetrics "github.com/aws-controllers-k8s/runtime/pkg/metrics"
+	acktypes "github.com/aws-controllers-k8s/runtime/pkg/types"
+	"github.com/aws-controllers-k8s/sagemaker-controller/pkg/testutil"
+	mocksvcsdkapi "github.com/aws-controllers-k8s/sagemaker-controller/test/mocks/aws-sdk-go/sagemaker"
+	svcsdk "github.com/aws/aws-sdk-go/service/sagemaker"
+	"github.com/ghodss/yaml"
+	"github.com/google/go-cmp/cmp"
+	"github.com/google/go-cmp/cmp/cmpopts"
+	"go.uber.org/zap/zapcore"
+	ctrlrtzap "sigs.k8s.io/controller-runtime/pkg/log/zap"
+)
+
+// provideResourceManagerWithMockSDKAPI accepts MockSageMakerAPI and returns pointer to resourceManager
+// the returned resourceManager is configured to use mockapi api.
+func provideResourceManagerWithMockSDKAPI(mockSageMakerAPI *mocksvcsdkapi.SageMakerAPI) *resourceManager {
+	zapOptions := ctrlrtzap.Options{
+		Development: true,
+		Level:       zapcore.InfoLevel,
+	}
+	fakeLogger := ctrlrtzap.New(ctrlrtzap.UseFlagOptions(&zapOptions))
+	return &resourceManager{
+		rr:           nil,
+		awsAccountID: "",
+		awsRegion:    "",
+		sess:         nil,
+		sdkapi:       mockSageMakerAPI,
+		log:          fakeLogger,
+		metrics:      ackmetrics.NewMetrics("sagemaker"),
+	}
+}
+
+// TestNotebookInstance runs the test suite for feature group
+func TestNotebookInstanceTestSuite(t *testing.T) {
+	defer func() {
+		if r := recover(); r != nil {
+			fmt.Println(testutil.RecoverPanicString, r)
+			t.Fail()
+		}
+	}()
+	var ts = testutil.TestSuite{}
+	testutil.LoadFromFixture(filepath.Join("testdata", "test_suite.yaml"), &ts)
+	var delegate = testRunnerDelegate{t: t}
+	var runner = testutil.TestSuiteRunner{TestSuite: &ts, Delegate: &delegate}
+	runner.RunTests()
+}
+
+// testRunnerDelegate implements testutil.TestRunnerDelegate
+type testRunnerDelegate struct {
+	t *testing.T
+}
+
+func (d *testRunnerDelegate) ResourceDescriptor() acktypes.AWSResourceDescriptor {
+	return &resourceDescriptor{}
+}
+
+func (d *testRunnerDelegate) ResourceManager(mocksdkapi *mocksvcsdkapi.SageMakerAPI) acktypes.AWSResourceManager {
+	return provideResourceManagerWithMockSDKAPI(mocksdkapi)
+}
+
+func (d *testRunnerDelegate) GoTestRunner() *testing.T {
+	return d.t
+}
+
+func (d *testRunnerDelegate) EmptyServiceAPIOutput(apiName string) (interface{}, error) {
+	if apiName == "" {
+		return nil, errors.New("no API name specified")
+	}
+	//TODO: use reflection, template to auto generate this block/method.
+	switch apiName {
+	case "CreateNotebookInstanceWithContext":
+		var output svcsdk.CreateNotebookInstanceOutput
+		return &output, nil
+	case "DeleteNotebookInstanceWithContext":
+		var output svcsdk.DeleteNotebookInstanceOutput
+		return &output, nil
+	case "DescribeNotebookInstanceWithContext":
+		var output svcsdk.DescribeNotebookInstanceOutput
+		return &output, nil
+	case "UpdateNotebookInstanceWithContext":
+		var output svcsdk.UpdateNotebookInstanceOutput
+		return &output, nil
+	case "StartNotebookInstance":
+		var output svcsdk.StartNotebookInstanceOutput
+		return &output, nil
+	case "StopNotebookInstance":
+		var output svcsdk.StopNotebookInstanceOutput
+		return &output, nil
+	}
+	return nil, errors.New(fmt.Sprintf("no matching API name found for: %s", apiName))
+}
+
+func (d *testRunnerDelegate) Equal(a acktypes.AWSResource, b acktypes.AWSResource) bool {
+	ac := a.(*resource)
+	bc := b.(*resource)
+	// Ignore LastTransitionTime since it gets updated each run.
+	opts := []cmp.Option{cmpopts.EquateEmpty(), cmpopts.IgnoreFields(ackv1alpha1.Condition{}, "LastTransitionTime")}
+
+	if cmp.Equal(ac.ko.Status, bc.ko.Status, opts...) {
+		return true
+	} else {
+		fmt.Printf("Difference (-expected +actual):\n\n")
+		fmt.Println(cmp.Diff(ac.ko.Status, bc.ko.Status, opts...))
+		return false
+	}
+}
+
+// Checks to see if the given yaml file, with name stored as expectation,
+// matches the yaml marshal of the AWSResource stored as actual.
+func (d *testRunnerDelegate) YamlEqual(expectation string, actual acktypes.AWSResource) bool {
+	// Build a tmp file for the actual yaml.
+	actualResource := actual.(*resource)
+	actualYamlByteArray, _ := yaml.Marshal(actualResource.ko)
+	return testutil.IsYamlEqual(&expectation, &actualYamlByteArray)
+}

pkg/resource/notebook_instance/testdata/sdkapi/create/create_success.json

@@ -0,0 +1,3 @@
+{
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test"
+}

pkg/resource/notebook_instance/testdata/sdkapi/readone/delete_resp.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": null,
+  "AdditionalCodeRepositories": null,
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": null,
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": null,
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": null,
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": null,
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "Deleting",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": null,
+  "SubnetId": null,
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 8
+ }

pkg/resource/notebook_instance/testdata/sdkapi/readone/readone_deleting.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": null,
+  "AdditionalCodeRepositories": null,
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": null,
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": null,
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": null,
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": null,
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "Deleting",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": null,
+  "SubnetId": null,
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 8
+ }

pkg/resource/notebook_instance/testdata/sdkapi/readone/readone_failed_state.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": null,
+  "AdditionalCodeRepositories": null,
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": null,
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": "VolumeError",
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": null,
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": null,
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "Failed",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": null,
+  "SubnetId": null,
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 8
+ }

pkg/resource/notebook_instance/testdata/sdkapi/readone/readone_inservice.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": ["ml.eia1.medium"],
+  "AdditionalCodeRepositories": ["code-repo"],
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": "my-code",
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": null,
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": "op",
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": "my-lfc",
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "InService",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": ["woof"],
+  "SubnetId": "abc",
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 8
+ }

pkg/resource/notebook_instance/testdata/sdkapi/readone/readone_pending_after_create.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": null,
+  "AdditionalCodeRepositories": null,
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": null,
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": null,
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": null,
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": null,
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "Pending",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": null,
+  "SubnetId": null,
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 8
+ }

pkg/resource/notebook_instance/testdata/sdkapi/readone/readone_stopped.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": null,
+  "AdditionalCodeRepositories": null,
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": null,
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": null,
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": null,
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": null,
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "Stopped",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": null,
+  "SubnetId": null,
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 8
+ }

pkg/resource/notebook_instance/testdata/sdkapi/readone/readone_stopped_after_update_ack.json

@@ -0,0 +1,22 @@
+{
+  "AcceleratorTypes": null,
+  "AdditionalCodeRepositories": null,
+  "CreationTime": "0001-01-01T00:00:00Z",
+  "DefaultCodeRepository": null,
+  "DirectInternetAccess": "Enabled",
+  "FailureReason": null,
+  "InstanceType": "ml.t2.medium",
+  "KmsKeyId": null,
+  "LastModifiedTime": "2021-08-15T22:06:18.767Z",
+  "NetworkInterfaceId": null,
+  "NotebookInstanceArn": "arn:aws:sagemaker:us-east-2:1234:notebook-instance/test",
+  "NotebookInstanceLifecycleConfigName": null,
+  "NotebookInstanceName": "test",
+  "NotebookInstanceStatus": "Stopped",
+  "RoleArn": "arn:aws:iam::1234:role/service-role/AmazonSageMakerServiceCatalogProductsUseRole",
+  "RootAccess": "Enabled",
+  "SecurityGroups": null,
+  "SubnetId": null,
+  "Url": "test.notebook.us-east-2.sagemaker.aws",
+  "VolumeSizeInGB": 9
+ }