refactor to support multiple providers

[jacobsalmela]

Summary and Scope

Overview

• moves csm-specific things out of cmd, domain, and provider packages and into csm
• passes cmd *cobra.Command, args []string from the cmd layer down each provider (allowing them to define the logic and flags)
• removes provider.ConfigOptions since these can now be gathered direct from the cobra command or by reading the config file
• creates a validation object in the csm package called ToBeValidated, as a result of the above (also to prevent import cycle errors)
• converts validate functions to methods of *CSM
• changes the cani.yml to be a map of providers and their respective options
• creates a CsmOpts type in the csm package, which holds all the cray things
• adjusts variable names as needed along the way

Risks and Mitigations

internal/provider/csm

• added a new NewSessionInitCommand() function, which each provider will do to set their own options in their own package
• removed ConfigOptions{} in favor of csm.CsmOpts{}
• adds a GetProviderOptions() function for the upper layers to use (i.e. writing options to config file)
• ToBeValidated{} object is created for anything needing validation (k8s CIDRS, roles/subroles, etc)
• adjusted variables/names/paths as needed with above changes
• conforms to the Provider interface below

internal/provider

• removes ConfigOptions interface contstraint
• removes SlsProvider type in favor of a provider constraint ExportJson(ctx context.Context, datastore inventory.Datastore, skipValidation bool) ([]byte, error)
• SetProviderOptions constraint, which accepts a cmd and args (from cobra)
• GetProviderOptions to get the options when needed

internal/inventory

• genericized the NewDatastoreJSON() and made NewDatastoreJSONCSM() for the csm provider
• added json/yaml tags to struct

internal/domain

• made a generic ExportJson() function (not specific to sls)
• moved DomainOptions into Domain since the provider can set these in their own package now
• created SetupDomain(), which sets up the required three components for most ops: hardwaretypeLibrary, a datastore, and a provider interface object
• uses a switch case for different providers needing different settings
• removed ExportSls() since the provider has it as a method and is csm-specific

cmd

• added a setupDomain(), which sets up the domain for every command to use. this is run by the root command as a PersistentPreRunE: setupDomain, and it sets a D variable (similar to the d used by each package before)
• uses root.D in places where an unexported var was used, this should always be the active domain
• all setup of cmds/flags, etc. are all moved to init(). an example is the BootstrapInitCmd is fairly generic, but when the NewSessionInitCmd() from the provider is called, the cmd's flags and such are replaced by that set by the provider
• session init has the biggest makeover since all the csm-specific info was moved into the csm package. it is adjusted to use the root.D object
• DatastoreExists() removed in favor of logic in setupDomain()

spec

• adjusted tests as needed now that a map of providers is used instead of a single one
• one blade test is commented out because it gives inconsistent results since we are dynamically getting all blade types from the cani command and each have their own ordinals that change (this can be addressed later)
• the show summary code does not run, and I still need to figure out why, but the tavern tests still yield good results

Medium. A few tests needed modifications since we use a map of providers now instead of a singular one. The code is shuffled quite a bit, but I kept the test changes to a minimum for more confidence in the changes.

[jacobsalmela]

@shunr-hpe @rsjostrand-hpe

Since I changed very little in the tests--only some verbiage and adding new fixtures--this can safely merge with your approval.

There are still CSM-specific things to adjust and remove from cmd/domain packages, but this gives us a nice starting point.