mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
92 lines
3.5 KiB
Go
92 lines
3.5 KiB
Go
package cmd
|
|
|
|
import (
|
|
"github.com/SAP/jenkins-library/pkg/config"
|
|
"github.com/SAP/jenkins-library/pkg/log"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
type karmaExecuteTestsOptions struct {
|
|
InstallCommand string `json:"installCommand,omitempty"`
|
|
ModulePath string `json:"modulePath,omitempty"`
|
|
RunCommand string `json:"runCommand,omitempty"`
|
|
}
|
|
|
|
var myKarmaExecuteTestsOptions karmaExecuteTestsOptions
|
|
var karmaExecuteTestsStepConfigJSON string
|
|
|
|
// KarmaExecuteTestsCommand Executes the Karma test runner
|
|
func KarmaExecuteTestsCommand() *cobra.Command {
|
|
metadata := karmaExecuteTestsMetadata()
|
|
var createKarmaExecuteTestsCmd = &cobra.Command{
|
|
Use: "karmaExecuteTests",
|
|
Short: "Executes the Karma test runner",
|
|
Long: `In this step the ([Karma test runner](http://karma-runner.github.io)) is executed.
|
|
|
|
The step is using the ` + "`" + `seleniumExecuteTest` + "`" + ` step to spin up two containers in a Docker network:
|
|
|
|
* a Selenium/Chrome container (` + "`" + `selenium/standalone-chrome` + "`" + `)
|
|
* a NodeJS container (` + "`" + `node:8-stretch` + "`" + `)
|
|
|
|
In the Docker network, the containers can be referenced by the values provided in ` + "`" + `dockerName` + "`" + ` and ` + "`" + `sidecarName` + "`" + `, the default values are ` + "`" + `karma` + "`" + ` and ` + "`" + `selenium` + "`" + `. These values must be used in the ` + "`" + `hostname` + "`" + ` properties of the test configuration ([Karma](https://karma-runner.github.io/1.0/config/configuration-file.html) and [WebDriver](https://github.com/karma-runner/karma-webdriver-launcher#usage)).
|
|
|
|
!!! note
|
|
In a Kubernetes environment, the containers both need to be referenced with ` + "`" + `localhost` + "`" + `.`,
|
|
PreRunE: func(cmd *cobra.Command, args []string) error {
|
|
log.SetStepName("karmaExecuteTests")
|
|
log.SetVerbose(GeneralConfig.Verbose)
|
|
return PrepareConfig(cmd, &metadata, "karmaExecuteTests", &myKarmaExecuteTestsOptions, config.OpenPiperFile)
|
|
},
|
|
RunE: func(cmd *cobra.Command, args []string) error {
|
|
return karmaExecuteTests(myKarmaExecuteTestsOptions)
|
|
},
|
|
}
|
|
|
|
addKarmaExecuteTestsFlags(createKarmaExecuteTestsCmd)
|
|
return createKarmaExecuteTestsCmd
|
|
}
|
|
|
|
func addKarmaExecuteTestsFlags(cmd *cobra.Command) {
|
|
cmd.Flags().StringVar(&myKarmaExecuteTestsOptions.InstallCommand, "installCommand", "npm install --quiet", "The command that is executed to install the test tool.")
|
|
cmd.Flags().StringVar(&myKarmaExecuteTestsOptions.ModulePath, "modulePath", ".", "Define the path of the module to execute tests on.")
|
|
cmd.Flags().StringVar(&myKarmaExecuteTestsOptions.RunCommand, "runCommand", "npm run karma", "The command that is executed to start the tests.")
|
|
|
|
cmd.MarkFlagRequired("installCommand")
|
|
cmd.MarkFlagRequired("modulePath")
|
|
cmd.MarkFlagRequired("runCommand")
|
|
}
|
|
|
|
// retrieve step metadata
|
|
func karmaExecuteTestsMetadata() config.StepData {
|
|
var theMetaData = config.StepData{
|
|
Spec: config.StepSpec{
|
|
Inputs: config.StepInputs{
|
|
Parameters: []config.StepParameters{
|
|
{
|
|
Name: "installCommand",
|
|
Scope: []string{"GENERAL", "PARAMETERS", "STAGES", "STEPS"},
|
|
Type: "string",
|
|
Mandatory: true,
|
|
Aliases: []config.Alias{},
|
|
},
|
|
{
|
|
Name: "modulePath",
|
|
Scope: []string{"PARAMETERS", "STAGES", "STEPS"},
|
|
Type: "string",
|
|
Mandatory: true,
|
|
Aliases: []config.Alias{},
|
|
},
|
|
{
|
|
Name: "runCommand",
|
|
Scope: []string{"GENERAL", "PARAMETERS", "STAGES", "STEPS"},
|
|
Type: "string",
|
|
Mandatory: true,
|
|
Aliases: []config.Alias{},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
return theMetaData
|
|
}
|