/*
Copyright 2020 The cert-manager Authors.

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 certificates

import (
	"context"

	"github.com/cert-manager/cert-manager/e2e-tests/framework"
	"github.com/cert-manager/cert-manager/e2e-tests/framework/helper/featureset"
	"github.com/cert-manager/cert-manager/internal/controller/feature"
	cmmeta "github.com/cert-manager/cert-manager/pkg/apis/meta/v1"
	utilfeature "github.com/cert-manager/cert-manager/pkg/util/feature"

	. "github.com/onsi/ginkgo/v2"
)

// Suite defines a reusable conformance test suite that can be used against any
// Issuer implementation.
type Suite struct {
	// Name is the name of the issuer being tested, e.g., SelfSigned, CA, ACME
	// This field must be provided.
	Name string

	// CreateIssuerFunc is a function that provisions a new issuer resource and
	// returns an ObjectReference to that Issuer that will be used as the
	// IssuerRef on Certificate resources that this suite creates.
	// This field must be provided.
	CreateIssuerFunc func(context.Context, *framework.Framework) cmmeta.IssuerReference

	// DeleteIssuerFunc is a function that is run after the test has completed
	// in order to clean up resources created for a test (e.g., the resources
	// created in CreateIssuerFunc).
	// This function will be run regardless whether the test passes or fails.
	// If not specified, this function will be skipped.
	DeleteIssuerFunc func(context.Context, *framework.Framework, cmmeta.IssuerReference)

	// SharedIPAddress is the IP address that will be used in all certificates
	// that require an IP address to be set. For HTTP-01 tests, this IP address
	// will be set to the IP address of the Ingress/ Gateway controller.
	SharedIPAddress string

	// DomainSuffix is a suffix used on all domain requests.
	// This is useful when the issuer being tested requires special
	// configuration for a set of domains in order for certificates to be
	// issued, such as the ACME issuer.
	// If not set, this will be defaulted to the configured 'domain' for the
	// nginx-ingress addon.
	DomainSuffix string

	// HTTP01TestType is set to "Ingress" or "Gateway" to determine which IPs
	// and Domains will be used to run the ACME HTTP-01 test suites.
	HTTP01TestType string

	// UnsupportedFeatures is a list of features that are not supported by this
	// invocation of the test suite.
	// This is useful if a particular issuers explicitly does not support
	// certain features due to restrictions in their implementation.
	UnsupportedFeatures featureset.FeatureSet

	// validated is used internally to track whether Validate has been called already.
	validated bool
}

// setup will set default values for fields on the Suite struct.
func (s *Suite) setup(f *framework.Framework) {
	if s.SharedIPAddress == "" {
		switch s.HTTP01TestType {
		case "Ingress":
			s.SharedIPAddress = f.Config.Addons.ACMEServer.IngressIP
		case "Gateway":
			s.SharedIPAddress = f.Config.Addons.ACMEServer.GatewayIP
		default:
			s.SharedIPAddress = "127.0.0.1"
		}
	}

	if s.DomainSuffix == "" {
		switch s.HTTP01TestType {
		case "Ingress":
			s.DomainSuffix = f.Config.Addons.IngressController.Domain
		case "Gateway":
			s.DomainSuffix = f.Config.Addons.Gateway.Domain
		default:
			s.DomainSuffix = "example.com"
		}
	}

	if s.UnsupportedFeatures == nil {
		s.UnsupportedFeatures = make(featureset.FeatureSet)
	}
}

// validate will validate the Suite struct to ensure all required fields are set.
func (s *Suite) validate() {
	if s.validated {
		return
	}

	if s.Name == "" {
		Fail("Name must be set")
	}

	if s.CreateIssuerFunc == nil {
		Fail("CreateIssuerFunc must be set")
	}

	if s.HTTP01TestType == "Gateway" {
		framework.RequireFeatureGate(utilfeature.DefaultFeatureGate, feature.ExperimentalGatewayAPISupport)
	}

	s.validated = true
}

// it is called by the tests to in Define() to setup and run the test
func (s *Suite) it(f *framework.Framework, name string, fn func(context.Context, cmmeta.IssuerReference), requiredFeatures ...featureset.Feature) {
	if s.UnsupportedFeatures.HasAny(requiredFeatures...) {
		return
	}
	It(name, func(testingCtx context.Context) {
		By("Creating an issuer resource")
		issuerRef := s.CreateIssuerFunc(testingCtx, f)
		defer func() {
			if s.DeleteIssuerFunc != nil {
				By("Cleaning up the issuer resource")
				s.DeleteIssuerFunc(testingCtx, f, issuerRef)
			}
		}()
		fn(testingCtx, issuerRef)
	})
}
