istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/test/framework/resource/environment.go (about)

     1  // Copyright Istio Authors
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package resource
    16  
    17  import "istio.io/istio/pkg/test/framework/components/cluster"
    18  
    19  // EnvironmentFactory creates an Environment.
    20  type EnvironmentFactory func(ctx Context) (Environment, error)
    21  
    22  var _ EnvironmentFactory = NilEnvironmentFactory
    23  
    24  // NilEnvironmentFactory is an EnvironmentFactory that returns nil.
    25  func NilEnvironmentFactory(Context) (Environment, error) {
    26  	return nil, nil
    27  }
    28  
    29  // Environment is the ambient environment that the test runs in.
    30  type Environment interface {
    31  	Resource
    32  
    33  	EnvironmentName() string
    34  
    35  	// Clusters in this Environment. There will always be at least one.
    36  	Clusters() cluster.Clusters
    37  
    38  	// AllClusters in this Environment, including external control planes.
    39  	AllClusters() cluster.Clusters
    40  	IsMultiCluster() bool
    41  	IsMultiNetwork() bool
    42  }