pulumi/sdk/go/auto/optpreview/optpreview.go

213 lines
6.8 KiB
Go
Raw Permalink Normal View History

2020-08-27 17:43:23 +00:00
// Copyright 2016-2020, Pulumi Corporation.
//
// 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 optpreview contains functional options to be used with stack preview operations
// github.com/sdk/v2/go/x/auto Stack.Preview(...optpreview.Option)
package optpreview
import (
"io"
"github.com/pulumi/pulumi/sdk/v3/go/auto/debug"
"github.com/pulumi/pulumi/sdk/v3/go/auto/events"
)
// Parallel is the number of resource operations to run in parallel at once during the update
// (1 for no parallelism). Defaults to unbounded. (default 2147483647)
func Parallel(n int) Option {
return optionFunc(func(opts *Options) {
opts.Parallel = n
})
}
// Message (optional) to associate with the preview operation
func Message(message string) Option {
return optionFunc(func(opts *Options) {
opts.Message = message
})
}
// ExpectNoChanges will cause the preview to return an error if any changes occur
func ExpectNoChanges() Option {
return optionFunc(func(opts *Options) {
opts.ExpectNoChanges = true
})
}
// Diff displays operation as a rich diff showing the overall change
func Diff() Option {
return optionFunc(func(opts *Options) {
opts.Diff = true
})
}
// Replace specifies an array of resource URNs to explicitly replace during the preview
func Replace(urns []string) Option {
return optionFunc(func(opts *Options) {
opts.Replace = urns
})
}
// Target specifies an exclusive list of resource URNs to update
func Target(urns []string) Option {
return optionFunc(func(opts *Options) {
opts.Target = urns
})
}
// TargetDependents allows updating of dependent targets discovered but not specified in the Target list
func TargetDependents() Option {
return optionFunc(func(opts *Options) {
opts.TargetDependents = true
})
}
// DebugLogging provides options for verbose logging to standard error, and enabling plugin logs.
func DebugLogging(debugOpts debug.LoggingOptions) Option {
return optionFunc(func(opts *Options) {
opts.DebugLogOpts = debugOpts
})
}
// ProgressStreams allows specifying one or more io.Writers to redirect incremental preview stdout
func ProgressStreams(writers ...io.Writer) Option {
return optionFunc(func(opts *Options) {
opts.ProgressStreams = writers
})
}
// ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental preview stderr
func ErrorProgressStreams(writers ...io.Writer) Option {
return optionFunc(func(opts *Options) {
opts.ErrorProgressStreams = writers
})
}
// EventStreams allows specifying one or more channels to receive the Pulumi event stream
func EventStreams(channels ...chan<- events.EngineEvent) Option {
return optionFunc(func(opts *Options) {
opts.EventStreams = channels
})
}
// UserAgent specifies the agent responsible for the update, stored in backends as "environment.exec.agent"
func UserAgent(agent string) Option {
return optionFunc(func(opts *Options) {
opts.UserAgent = agent
})
}
// Plan specifies the path where the update plan should be saved.
func Plan(path string) Option {
return optionFunc(func(opts *Options) {
opts.Plan = path
})
}
2024-02-02 22:26:41 +00:00
// Refresh will run a refresh before the preview.
func Refresh() Option {
return optionFunc(func(opts *Options) {
opts.Refresh = true
})
}
Support suppress-progress and suppress-outputs options (#15596) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Introduces support for `--suppress-progress` and `--suppress-outputs` parameters of the cli for stack `up`, `destroy`, `preview`, and `refresh`. Fixes https://github.com/pulumi/pulumi/issues/12549 precondition for: https://github.com/pulumi/actions/issues/1108 ## Checklist I'm not running any of the ones below as it's at least shady what it requires and the way it runs - [x] I have run `make tidy` to update any new dependencies - [ ] I have run `make lint` to verify my code passes the lint check _-> fails with `ERRO Running error: unknown linters: 'perfsprint', run 'golangci-lint help linters' to see the list of supported linters `_ - [ ] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works _-> current params dont seem to be tested in any way, and it's not easily testable as its directly dependent on the cli_ <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> --------- Co-authored-by: Thomas Gummerer <t.gummerer@gmail.com>
2024-03-07 09:29:24 +00:00
// Suppress display of periodic progress dots
func SuppressProgress() Option {
return optionFunc(func(opts *Options) {
opts.SuppressProgress = true
})
}
// Suppress display of stack outputs (in case they contain sensitive values)
func SuppressOutputs() Option {
return optionFunc(func(opts *Options) {
opts.SuppressOutputs = true
})
}
add support for --import-file when using the Automation API (#16071) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes # (issue) ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> --------- Co-authored-by: Thomas Gummerer <t.gummerer@gmail.com>
2024-04-30 11:31:43 +00:00
// ImportFile save any creates seen during the preview into an import file to use with pulumi import
func ImportFile(path string) Option {
return optionFunc(func(opts *Options) {
opts.ImportFile = path
})
}
// AttachDebugger will run the process under a debugger, and pause until a debugger is attached
func AttachDebugger() Option {
return optionFunc(func(opts *Options) {
opts.AttachDebugger = true
})
}
// Option is a parameter to be applied to a Stack.Preview() operation
type Option interface {
ApplyOption(*Options)
}
// ---------------------------------- implementation details ----------------------------------
// Options is an implementation detail
type Options struct {
// Parallel is the number of resource operations to run in parallel at once
// (1 for no parallelism). Defaults to unbounded. (default 2147483647)
Parallel int
// Message (optional) to associate with the preview operation
Message string
// Return an error if any changes occur during this preview
ExpectNoChanges bool
// Diff displays operation as a rich diff showing the overall change
Diff bool
// Specify resources to replace
Replace []string
// Specify an exclusive list of resource URNs to update
Target []string
// Allows updating of dependent targets discovered but not specified in the Target list
TargetDependents bool
// DebugLogOpts specifies additional settings for debug logging
DebugLogOpts debug.LoggingOptions
// ProgressStreams allows specifying one or more io.Writers to redirect incremental preview stdout
ProgressStreams []io.Writer
// ErrorProgressStreams allows specifying one or more io.Writers to redirect incremental preview stderr
ErrorProgressStreams []io.Writer
// EventStreams allows specifying one or more channels to receive the Pulumi event stream
EventStreams []chan<- events.EngineEvent
// UserAgent specifies the agent responsible for the update, stored in backends as "environment.exec.agent"
UserAgent string
// Colorize output. Choices are: always, never, raw, auto (default "auto")
Color string
// Save an update plan to the given path.
Plan string
// Run one or more policy packs as part of this update
PolicyPacks []string
// Path to JSON file containing the config for the policy pack of the corresponding "--policy-pack" flag
PolicyPackConfigs []string
2024-02-02 22:26:41 +00:00
// Refresh will run a refresh before the preview.
Refresh bool
Support suppress-progress and suppress-outputs options (#15596) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Introduces support for `--suppress-progress` and `--suppress-outputs` parameters of the cli for stack `up`, `destroy`, `preview`, and `refresh`. Fixes https://github.com/pulumi/pulumi/issues/12549 precondition for: https://github.com/pulumi/actions/issues/1108 ## Checklist I'm not running any of the ones below as it's at least shady what it requires and the way it runs - [x] I have run `make tidy` to update any new dependencies - [ ] I have run `make lint` to verify my code passes the lint check _-> fails with `ERRO Running error: unknown linters: 'perfsprint', run 'golangci-lint help linters' to see the list of supported linters `_ - [ ] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works _-> current params dont seem to be tested in any way, and it's not easily testable as its directly dependent on the cli_ <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> --------- Co-authored-by: Thomas Gummerer <t.gummerer@gmail.com>
2024-03-07 09:29:24 +00:00
// Suppress display of periodic progress dots
SuppressProgress bool
// Suppress display of stack outputs (in case they contain sensitive values)
SuppressOutputs bool
add support for --import-file when using the Automation API (#16071) <!--- Thanks so much for your contribution! If this is your first time contributing, please ensure that you have read the [CONTRIBUTING](https://github.com/pulumi/pulumi/blob/master/CONTRIBUTING.md) documentation. --> # Description <!--- Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. --> Fixes # (issue) ## Checklist - [x] I have run `make tidy` to update any new dependencies - [x] I have run `make lint` to verify my code passes the lint check - [x] I have formatted my code using `gofumpt` <!--- Please provide details if the checkbox below is to be left unchecked. --> - [ ] I have added tests that prove my fix is effective or that my feature works <!--- User-facing changes require a CHANGELOG entry. --> - [x] I have run `make changelog` and committed the `changelog/pending/<file>` documenting my change <!-- If the change(s) in this PR is a modification of an existing call to the Pulumi Cloud, then the service should honor older versions of the CLI where this change would not exist. You must then bump the API version in /pkg/backend/httpstate/client/api.go, as well as add it to the service. --> - [ ] Yes, there are changes in this PR that warrants bumping the Pulumi Cloud API version <!-- @Pulumi employees: If yes, you must submit corresponding changes in the service repo. --> --------- Co-authored-by: Thomas Gummerer <t.gummerer@gmail.com>
2024-04-30 11:31:43 +00:00
// Save any creates seen during the preview into an import file to use with pulumi import
ImportFile string
// Run the process under a debugger, and pause until a debugger is attached
AttachDebugger bool
}
type optionFunc func(*Options)
// ApplyOption is an implementation detail
func (o optionFunc) ApplyOption(opts *Options) {
o(opts)
}