hercules/internal/core/registry_test.go

package core

import (
	"os"
	"reflect"
	"testing"

	"github.com/spf13/cobra"
	"github.com/spf13/pflag"
	"github.com/stretchr/testify/assert"
	"gopkg.in/src-d/go-git.v4"
	"gopkg.in/src-d/hercules.v10/internal/test"
)

func getRegistry() *PipelineItemRegistry {
	return &PipelineItemRegistry{
		provided:     map[string][]reflect.Type{},
		registered:   map[string]reflect.Type{},
		flags:        map[string]reflect.Type{},
		featureFlags: arrayFeatureFlags{Flags: []string{}, Choices: map[string]bool{}},
	}
}

type dummyPipelineItem struct{}

func (item *dummyPipelineItem) Name() string {
	return "dummy"
}

func (item *dummyPipelineItem) Provides() []string {
	return []string{"dummy"}
}

func (item *dummyPipelineItem) Requires() []string {
	return []string{}
}

func (item *dummyPipelineItem) Features() []string {
	return []string{"power"}
}

func (item *dummyPipelineItem) Configure(facts map[string]interface{}) error {
	return nil
}

func (item *dummyPipelineItem) ListConfigurationOptions() []ConfigurationOption {
	options := [...]ConfigurationOption{{
		Name:        "DummyOption",
		Description: "The option description.",
		Flag:        "dummy-option",
		Type:        BoolConfigurationOption,
		Default:     false,
	}}
	return options[:]
}

func (item *dummyPipelineItem) Initialize(repository *git.Repository) error {
	return nil
}

func (item *dummyPipelineItem) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
	return map[string]interface{}{"dummy": nil}, nil
}

func (item *dummyPipelineItem) Fork(n int) []PipelineItem {
	return nil
}

func (item *dummyPipelineItem) Merge(branches []PipelineItem) {
}

type dummyPipelineItem2 struct{}

func (item *dummyPipelineItem2) Name() string {
	return "dummy2"
}

func (item *dummyPipelineItem2) Provides() []string {
	return []string{"dummy2"}
}

func (item *dummyPipelineItem2) Requires() []string {
	return []string{}
}

func (item *dummyPipelineItem2) Features() []string {
	return []string{"other"}
}

func (item *dummyPipelineItem2) Configure(facts map[string]interface{}) error {
	return nil
}

func (item *dummyPipelineItem2) ListConfigurationOptions() []ConfigurationOption {
	return []ConfigurationOption{}
}

func (item *dummyPipelineItem2) Initialize(repository *git.Repository) error {
	return nil
}

func (item *dummyPipelineItem2) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
	return map[string]interface{}{"dummy2": nil}, nil
}

func (item *dummyPipelineItem2) Fork(n int) []PipelineItem {
	return nil
}

func (item *dummyPipelineItem2) Merge(branches []PipelineItem) {
}

type dummyPipelineItem3 struct{}

func (item *dummyPipelineItem3) Name() string {
	return "dummy3"
}

func (item *dummyPipelineItem3) Provides() []string {
	return []string{"dummy3"}
}

func (item *dummyPipelineItem3) Requires() []string {
	return []string{"dummy"}
}

func (item *dummyPipelineItem3) Configure(facts map[string]interface{}) error {
	return nil
}

func (item *dummyPipelineItem3) ListConfigurationOptions() []ConfigurationOption {
	return nil
}

func (item *dummyPipelineItem3) Initialize(repository *git.Repository) error {
	return nil
}

func (item *dummyPipelineItem3) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
	return map[string]interface{}{"dummy": nil}, nil
}

func (item *dummyPipelineItem3) Fork(n int) []PipelineItem {
	return nil
}

func (item *dummyPipelineItem3) Merge(branches []PipelineItem) {
}

type dummyPipelineItem4 struct{}

func (item *dummyPipelineItem4) Name() string {
	return "dummy4"
}

func (item *dummyPipelineItem4) Provides() []string {
	return []string{"dummy4"}
}

func (item *dummyPipelineItem4) Requires() []string {
	return []string{"dummy3"}
}

func (item *dummyPipelineItem4) Configure(facts map[string]interface{}) error {
	return nil
}

func (item *dummyPipelineItem4) ListConfigurationOptions() []ConfigurationOption {
	return nil
}

func (item *dummyPipelineItem4) Initialize(repository *git.Repository) error {
	return nil
}

func (item *dummyPipelineItem4) Consume(deps map[string]interface{}) (map[string]interface{}, error) {
	return map[string]interface{}{"dummy": nil}, nil
}

func (item *dummyPipelineItem4) Fork(n int) []PipelineItem {
	return nil
}

func (item *dummyPipelineItem4) Merge(branches []PipelineItem) {
}

func TestRegistrySummon(t *testing.T) {
	reg := getRegistry()
	assert.Len(t, reg.Summon("whatever"), 0)
	reg.Register(&testPipelineItem{})
	summoned := reg.Summon((&testPipelineItem{}).Provides()[0])
	assert.Len(t, summoned, 1)
	assert.Equal(t, summoned[0].Name(), (&testPipelineItem{}).Name())
	summoned = reg.Summon((&testPipelineItem{}).Name())
	assert.Len(t, summoned, 1)
	assert.Equal(t, summoned[0].Name(), (&testPipelineItem{}).Name())
}

func TestRegistryAddFlags(t *testing.T) {
	reg := getRegistry()
	reg.Register(&testPipelineItem{})
	reg.Register(&dummyPipelineItem{})
	testCmd := &cobra.Command{
		Use:   "test",
		Short: "Temporary command to test the stuff.",
		Long:  ``,
		Args:  cobra.MaximumNArgs(0),
		Run:   func(cmd *cobra.Command, args []string) {},
	}
	facts, deployed := reg.AddFlags(testCmd.Flags())
	assert.Len(t, facts, 7)
	assert.IsType(t, 0, facts[(&testPipelineItem{}).ListConfigurationOptions()[0].Name])
	assert.IsType(t, true, facts[(&dummyPipelineItem{}).ListConfigurationOptions()[0].Name])
	assert.Contains(t, facts, ConfigPipelineDryRun)
	assert.Contains(t, facts, ConfigPipelineDAGPath)
	assert.Contains(t, facts, ConfigPipelineDumpPlan)
	assert.Contains(t, facts, ConfigPipelineHibernationDistance)
	assert.Len(t, deployed, 1)
	assert.Contains(t, deployed, (&testPipelineItem{}).Name())
	assert.NotNil(t, testCmd.Flags().Lookup((&testPipelineItem{}).Flag()))
	assert.NotNil(t, testCmd.Flags().Lookup("feature"))
	assert.NotNil(t, testCmd.Flags().Lookup("dump-dag"))
	assert.NotNil(t, testCmd.Flags().Lookup("dump-plan"))
	assert.NotNil(t, testCmd.Flags().Lookup("dry-run"))
	assert.NotNil(t, testCmd.Flags().Lookup("hibernation-distance"))
	assert.NotNil(t, testCmd.Flags().Lookup("print-actions"))
	assert.NotNil(t, testCmd.Flags().Lookup(
		(&testPipelineItem{}).ListConfigurationOptions()[0].Flag))
	assert.NotNil(t, testCmd.Flags().Lookup(
		(&dummyPipelineItem{}).ListConfigurationOptions()[0].Flag))
	testCmd.UsageString() // to test that nothing is broken
}

func TestRegistryFeatures(t *testing.T) {
	reg := getRegistry()
	reg.Register(&dummyPipelineItem{})
	reg.Register(&dummyPipelineItem2{})
	testCmd := &cobra.Command{
		Use:   "test",
		Short: "Temporary command to test the stuff.",
		Long:  ``,
		Args:  cobra.MaximumNArgs(0),
		Run:   func(cmd *cobra.Command, args []string) {},
	}
	reg.AddFlags(testCmd.Flags())
	args := [...]string{"--feature", "other", "--feature", "power"}
	testCmd.ParseFlags(args[:])
	pipeline := NewPipeline(test.Repository)
	val, _ := pipeline.GetFeature("power")
	assert.False(t, val)
	val, _ = pipeline.GetFeature("other")
	assert.False(t, val)
	pipeline.SetFeaturesFromFlags(reg)
	val, _ = pipeline.GetFeature("power")
	assert.True(t, val)
	val, _ = pipeline.GetFeature("other")
	assert.True(t, val)
}

func TestRegistryCollectAllDependencies(t *testing.T) {
	reg := getRegistry()
	reg.Register(&dummyPipelineItem{})
	reg.Register(&dummyPipelineItem3{})
	reg.Register(&dummyPipelineItem4{})
	assert.Len(t, reg.CollectAllDependencies(&dummyPipelineItem{}), 0)
	deps := reg.CollectAllDependencies(&dummyPipelineItem4{})
	assert.Len(t, deps, 2)
	assert.Equal(t, deps[0].Name(), (&dummyPipelineItem{}).Name())
	assert.Equal(t, deps[1].Name(), (&dummyPipelineItem3{}).Name())
}

func TestRegistryLeaves(t *testing.T) {
	reg := getRegistry()
	reg.Register(&testPipelineItem{})
	reg.Register(&dependingTestPipelineItem{})
	reg.Register(&dummyPipelineItem{})
	leaves := reg.GetLeaves()
	assert.Len(t, leaves, 2)
	assert.Equal(t, leaves[0].Name(), (&dependingTestPipelineItem{}).Name())
	assert.Equal(t, leaves[1].Name(), (&testPipelineItem{}).Name())
}

func TestRegistryPlumbingItems(t *testing.T) {
	reg := getRegistry()
	reg.Register(&testPipelineItem{})
	reg.Register(&dependingTestPipelineItem{})
	reg.Register(&dummyPipelineItem{})
	plumbing := reg.GetPlumbingItems()
	assert.Len(t, plumbing, 1)
	assert.Equal(t, plumbing[0].Name(), (&dummyPipelineItem{}).Name())
}

func TestRegistryFeaturedItems(t *testing.T) {
	reg := getRegistry()
	reg.Register(&testPipelineItem{})
	reg.Register(&dependingTestPipelineItem{})
	reg.Register(&dummyPipelineItem{})
	reg.Register(&dummyPipelineItem3{})
	reg.Register(&dummyPipelineItem4{})
	featured := reg.GetFeaturedItems()
	assert.Len(t, featured, 1)
	power := featured["power"]
	assert.Len(t, power, 5)
	assert.Equal(t, power[0].Name(), (&testPipelineItem{}).Name())
	assert.Equal(t, power[1].Name(), (&dependingTestPipelineItem{}).Name())
	assert.Equal(t, power[2].Name(), (&dummyPipelineItem{}).Name())
	assert.Equal(t, power[3].Name(), (&dummyPipelineItem3{}).Name())
	assert.Equal(t, power[4].Name(), (&dummyPipelineItem4{}).Name())
}

func TestRegistryPathMasquerade(t *testing.T) {
	fs := pflag.NewFlagSet(os.Args[0], pflag.ContinueOnError)
	var value string
	fs.StringVar(&value, "test", "", "usage")
	flag := fs.Lookup("test")
	PathifyFlagValue(flag)
	assert.Equal(t, flag.Value.Type(), "string")
	assert.Nil(t, flag.Value.Set("xxx"))
	assert.Equal(t, flag.Value.String(), "xxx")
	EnablePathFlagTypeMasquerade()
	assert.Equal(t, flag.Value.Type(), "path")
	assert.Equal(t, flag.Value.String(), "xxx")
}