pluginkit

type Armory struct {
	PluginName    string               `json:"pluginName"`    // PluginName is the name of the plugin
	ServiceTarget string               `json:"serviceTarget"` // ServiceTarget is the name of the service the plugin is running on
	Config        *config.Config       `json:"config"`        // Config is the global configuration for the plugin
	Logger        hclog.Logger         `json:"logger"`        // Logger is the global logger for the plugin
	TestSuites    map[string][]TestSet `json:"testSuites"`    // TestSuites is a map of testSuite names to their testSets
	StartupFunc   func() error         `json:"startupFunc"`   // StartupFunc is a function to run before the testSets
	CleanupFunc   func() error         `json:"cleanupFunc"`   // CleanupFunc is a function to run after the testSets
}

type Change struct {
	TargetName   string      `json:"targetName"`   // TargetName is the name of the resource or configuration that was changed
	TargetObject interface{} `json:"targetObject"` // TargetObject is the object that was changed
	Applied      bool        `json:"applied"`      // Applied is true if the change was successfully applied at least once
	Reverted     bool        `json:"reverted"`     // Reverted is true if the change was successfully reverted and not applied again
	Error        error       `json:"error"`        // Error is used if an error occurred during the change
	// contains filtered or unexported fields
}

type Test func() *TestResult

type TestResult struct {
	Passed      bool               `json:"passed"`      // Passed is true if the test passed
	Description string             `json:"description"` // Description is a human-readable description of the test
	Message     string             `json:"message"`     // Message is a human-readable description of the test result
	Function    string             `json:"function"`    // Function is the name of the code that was executed
	Value       interface{}        `json:"value"`       // Value is the object that was returned during the test
	Changes     map[string]*Change `json:"changes"`     // Changes is a slice of changes that were made during the test
}

type TestSet func() (testSetName string, result TestSetResult)

type TestSetResult struct {
	Passed        bool                  `json:"passed"`        // Passed is true if the test passed
	Description   string                `json:"description"`   // Description is a human-readable description of the test
	Message       string                `json:"message"`       // Message is a human-readable description of the test result
	DocsURL       string                `json:"docsURL"`       // DocsURL is a link to the documentation for the test
	ControlID     string                `json:"controlID"`     // ControlID is the ID of the control that the test is validating
	Tests         map[string]TestResult `json:"tests"`         // Tests is a list of functions that were executed during the test
	BadStateAlert bool                  `json:"badStateAlert"` // BadStateAlert is true if any change failed to revert at the end of the testSet
}

type TestSuite struct {
	TestSuiteName  string                   `json:"testSuiteName"`  // TestSuiteName is the name of the TestSuite
	StartTime      string                   `json:"startTime"`      // StartTime is the time the plugin started
	EndTime        string                   `json:"endTime"`        // EndTime is the time the plugin ended
	TestSetResults map[string]TestSetResult `json:"testSetResults"` // TestSetResults is a map of testSet names to their results
	Passed         bool                     `json:"passed"`         // Passed is true if all testSets in the testSuite passed
	BadStateAlert  bool                     `json:"badStateAlert"`  // BadState is true if any testSet failed to revert at the end of the testSuite
	// contains filtered or unexported fields
}

type Vessel struct {
	ServiceName  string                     `json:"serviceName"`
	PluginName   string                     `json:"pluginName"`
	RequiredVars []string                   `json:"requiredVars"`
	Armory       *Armory                    `json:"armory"`
	TestSuites   []TestSuite                `json:"testSuites"`
	Initializer  func(*config.Config) error `json:"initializer"`
	// contains filtered or unexported fields
}