mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-23 07:33:32 -06:00
3b79efa834
This continues our ongoing effort to get a coherent chain of context.Context all the way from "package main" to all of our calls to external components. Context.Refresh is really just a vestigal wrapper around Context.Plan, so this just passes the given context through to Context.Plan which itself currently ignores it. OpenTofu has some historical situational private uses of context.Context to handle the graceful shutdown behaviors. Those use context.Context as a private implementation detail rather than public API, and so this commit leaves them as-is and adds a new "primary context" alongside. Hopefully in future refactoring we can simplify this to use the primary context also as the primary cancellation signal, but that's too risky a change to bundle in with this otherwise-mostly-harmless context plumbing. All of the _test.go file updates here are purely mechanical additions of the extra argument. No test is materially modified by this change, which is intentional to get some assurance that isn't a breaking change. Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
44 lines
1.3 KiB
Go
44 lines
1.3 KiB
Go
// Copyright (c) The OpenTofu Authors
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
// Copyright (c) 2023 HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package tofu
|
|
|
|
import (
|
|
"context"
|
|
"log"
|
|
|
|
"github.com/opentofu/opentofu/internal/configs"
|
|
"github.com/opentofu/opentofu/internal/plans"
|
|
"github.com/opentofu/opentofu/internal/states"
|
|
"github.com/opentofu/opentofu/internal/tfdiags"
|
|
)
|
|
|
|
// Refresh is a vestigial operation that is equivalent to call to Plan and
|
|
// then taking the prior state of the resulting plan.
|
|
//
|
|
// We retain this only as a measure of semi-backward-compatibility for
|
|
// automation relying on the "tofu refresh" subcommand. The modern way
|
|
// to get this effect is to create and then apply a plan in the refresh-only
|
|
// mode.
|
|
func (c *Context) Refresh(ctx context.Context, config *configs.Config, prevRunState *states.State, opts *PlanOpts) (*states.State, tfdiags.Diagnostics) {
|
|
if opts == nil {
|
|
// This fallback is only here for tests, not for real code.
|
|
opts = &PlanOpts{
|
|
Mode: plans.NormalMode,
|
|
}
|
|
}
|
|
if opts.Mode != plans.NormalMode {
|
|
panic("can only Refresh in the normal planning mode")
|
|
}
|
|
|
|
log.Printf("[DEBUG] Refresh is really just plan now, so creating a %s plan", opts.Mode)
|
|
p, diags := c.Plan(ctx, config, prevRunState, opts)
|
|
if diags.HasErrors() {
|
|
return nil, diags
|
|
}
|
|
|
|
return p.PriorState, diags
|
|
}
|