// Copyright (c) 2018-2019,2021 Tigera, Inc. 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.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License 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 infrastructure

import (
	"net"

	. "github.com/onsi/gomega"

	api "github.com/projectcalico/api/pkg/apis/projectcalico/v3"

	"github.com/projectcalico/calico/felix/fv/utils"
	libapi "github.com/projectcalico/calico/libcalico-go/lib/apis/v3"
	client "github.com/projectcalico/calico/libcalico-go/lib/clientv3"
)

// DatastoreInfra is an interface that is to be used to abstract away
// the datastore being used and the functions that are datastore specific
type DatastoreInfra interface {
	// GetDockerArgs returns a string slice of args to be passed to the docker
	// run command when starting Typha or Felix. It includes
	// CALICO_DATASTORE_TYPE, FELIX_DATASTORETYPE, an appropriate endpoint,
	// and any datastore specific needed ones.
	GetDockerArgs() []string
	// GetBadEndpointDockerArgs returns the same as GetDockerArgs but the
	// endpoint returned will have the incorrect port.
	GetBadEndpointDockerArgs() []string

	// GetCalicoClient will return a client.Interface configured to access
	// the datastore.
	GetCalicoClient() client.Interface
	// GetClusterGUID will return the cluster GUID.
	GetClusterGUID() string
	// SetExpectedIPIPTunnelAddr will set the Felix object's
	// ExpectedIPIPTunnelAddr field, if we expect Felix to see that field being
	// set after it has started up for the first time.
	SetExpectedIPIPTunnelAddr(felix *Felix, cidr *net.IPNet, idx int, needBGP bool)
	// SetExpectedVXLANTunnelAddr will set the Felix object's
	// ExpectedVXLANTunnelAddr field, if we expect Felix to see that field being
	// set after it has started up for the first time.
	SetExpectedVXLANTunnelAddr(felix *Felix, cidr *net.IPNet, idx int, needVXLAN bool)
	SetExpectedVXLANV6TunnelAddr(felix *Felix, cidr *net.IPNet, idx int, needVXLAN bool)
	// SetExpectedWireguardTunnelAddr will set the Felix object's
	// ExpectedWireguardTunnelAddr field, if we expect Felix to see that field being
	// set after it has started up for the first time.
	SetExpectedWireguardTunnelAddr(felix *Felix, cidr *net.IPNet, idx int, needWireguard bool)
	// SetExpectedWireguardV6TunnelAddr will set the Felix object's
	// ExpectedWireguardV6TunnelAddr field, if we expect Felix to see that field being
	// set after it has started up for the first time.
	SetExpectedWireguardV6TunnelAddr(felix *Felix, cidr *net.IPNet, idx int, needWireguard bool)
	// RemoveNodeAddresses will remove all the addresses (InternalIP, ExternalIP)
	RemoveNodeAddresses(felix *Felix)
	// AddNode will take the appropriate steps to add a node to the datastore.
	// From the passed in felix the Hostname and IPv4 address will be pulled
	// and added to the Node appropriately.
	// The passed in idx will be used to setup the Tunnel or PodCIDR (from
	// which the tunnel is created). needBGP is used (only in etcd) to
	// add a NodeBGPSpec if true or otherwise not.
	AddNode(felix *Felix, v4CIDR *net.IPNet, v6CIDR *net.IPNet, idx int, needBGP bool)
	// AddWorkload will take the appropriate steps to create a workload in the
	// datastore with the passed in wep values. If this succeeds then the
	// *libapi.WorkloadEndpoint will be returned, otherwise an error will be
	// returned.
	AddWorkload(wep *libapi.WorkloadEndpoint) (*libapi.WorkloadEndpoint, error)
	// RemoveWorkload reverses the effect of AddWorkload.
	RemoveWorkload(ns string, name string) error
	// AddDefaultAllow will ensure that the datastore is configured so that
	// the default profile/namespace will allow traffic. Returns the name of the
	// default profile.
	AddDefaultAllow() string
	// AddDefaultDeny will ensure that the datastore is configured so that
	// the default profile/namespace will deny ingress traffic.
	AddDefaultDeny() error
	// AddAllowToDatastore adds a policy to allow endpoints that match the given
	// selector to reach the datastore.
	AddAllowToDatastore(selector string) error

	// DumpErrorData prints out extra information that may help when an error
	// occurs.
	DumpErrorData()

	// Stop cleans up anything necessary in preparation for the end of the test.
	Stop()
}

// Creates a default profile that allows workloads with this profile to talk to each
// other in the absence of any Policy.
func CreateDefaultProfile(c client.Interface, name string, labels map[string]string, entityRuleSelector string) {
	d := api.NewProfile()
	d.Name = name
	d.Spec.LabelsToApply = labels
	d.Spec.Egress = []api.Rule{{Action: api.Allow}}
	d.Spec.Ingress = []api.Rule{{
		Action: api.Allow,
		Source: api.EntityRule{Selector: entityRuleSelector},
	}}
	_, err := c.Profiles().Create(utils.Ctx, d, utils.NoOptions)
	Expect(err).NotTo(HaveOccurred())
}

type CreateOption func(DatastoreInfra)
