// Copyright 2020 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 common contains common methods, interfaces and variables used across the tester packages
package common

// ITestCase interface should be implemented by test cases
// to be picked up by test setup
type ITestCase interface {
	Initialize()
	ShouldRunTest() bool
	ExecuteTestCase() TestOutput
	CleanupTestCase()
	GetTestCaseName() string
}

// TestOutput is structure of test case execution result
type TestOutput struct {
	AdditionalInfo string
	Result         TestResult
	Err            error
}

type TestResult string

const (
	// TestCasePass denotes test case pass
	TestCasePass TestResult = "Pass"

	// TestCaseFail denotes test case fail
	TestCaseFail TestResult = "Fail"
)