istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/test/framework/resource/config/plan.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 config
    16  
    17  import (
    18  	"istio.io/istio/pkg/test"
    19  	"istio.io/istio/pkg/test/framework/resource/config/apply"
    20  )
    21  
    22  // Plan for configuration that can be applied or deleted as an atomic unit.
    23  // A Plan is initially created by a Factory, but then can continually be
    24  // appended to before finally calling Apply or Delete.
    25  type Plan interface {
    26  	// Factory for appending to this Config.
    27  	Factory
    28  
    29  	// Copy returns a deep copy of this Plan.
    30  	Copy() Plan
    31  
    32  	// Apply this config.
    33  	Apply(opts ...apply.Option) error
    34  	ApplyOrFail(t test.Failer, opts ...apply.Option)
    35  
    36  	// Delete this config.
    37  	Delete() error
    38  	DeleteOrFail(t test.Failer)
    39  }