Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commite400378

Browse files
committed
chore: refactor terraform paths to a central structure
The structure handles building paths for all relevant files.
1 parent197b422 commite400378

File tree

9 files changed

+226
-163
lines changed

9 files changed

+226
-163
lines changed

‎provisioner/echo/serve.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,8 @@ func readResponses(sess *provisionersdk.Session, trans string, suffix string) ([
122122
fori:=0; ;i++ {
123123
paths:= []string{
124124
// Try more specific path first, then fallback to generic.
125-
filepath.Join(sess.WorkDirectory,fmt.Sprintf("%d.%s.%s",i,trans,suffix)),
126-
filepath.Join(sess.WorkDirectory,fmt.Sprintf("%d.%s",i,suffix)),
125+
filepath.Join(sess.Files.WorkDirectory(),fmt.Sprintf("%d.%s.%s",i,trans,suffix)),
126+
filepath.Join(sess.Files.WorkDirectory(),fmt.Sprintf("%d.%s",i,suffix)),
127127
}
128128
forpathIndex,path:=rangepaths {
129129
_,err:=os.Stat(path)

‎provisioner/terraform/executor.go‎

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import (
1010
"io"
1111
"os"
1212
"os/exec"
13-
"path/filepath"
1413
"runtime"
1514
"strings"
1615
"sync"
@@ -22,6 +21,7 @@ import (
2221
"golang.org/x/xerrors"
2322

2423
"cdr.dev/slog"
24+
"github.com/coder/coder/v2/provisionersdk/tfpath"
2525

2626
"github.com/coder/coder/v2/coderd/database"
2727
"github.com/coder/coder/v2/coderd/tracing"
@@ -38,10 +38,10 @@ type executor struct {
3838
server*server
3939
mut*sync.Mutex
4040
binaryPathstring
41-
// cachePath andworkdir must not be used by multiple processes at once.
41+
// cachePath andfiles must not be used by multiple processes at once.
4242
cachePathstring
4343
cliConfigPathstring
44-
workdirstring
44+
files tfpath.Layout
4545
// used to capture execution times at various stages
4646
timings*timingAggregator
4747
}
@@ -90,7 +90,7 @@ func (e *executor) execWriteOutput(ctx, killCtx context.Context, args, env []str
9090

9191
// #nosec
9292
cmd:=exec.CommandContext(killCtx,e.binaryPath,args...)
93-
cmd.Dir=e.workdir
93+
cmd.Dir=e.files.WorkDirectory()
9494
ifenv==nil {
9595
// We don't want to passthrough host env when unset.
9696
env= []string{}
@@ -131,7 +131,7 @@ func (e *executor) execParseJSON(ctx, killCtx context.Context, args, env []strin
131131

132132
// #nosec
133133
cmd:=exec.CommandContext(killCtx,e.binaryPath,args...)
134-
cmd.Dir=e.workdir
134+
cmd.Dir=e.files.WorkDirectory()
135135
cmd.Env=env
136136
out:=&bytes.Buffer{}
137137
stdErr:=&bytes.Buffer{}
@@ -225,7 +225,7 @@ func (e *executor) init(ctx, killCtx context.Context, logr logSink) error {
225225
defere.mut.Unlock()
226226

227227
// Record lock file checksum before init
228-
lockFilePath:=filepath.Join(e.workdir,".terraform.lock.hcl")
228+
lockFilePath:=e.files.TerraformLockFile()
229229
preInitChecksum:=checksumFileCRC32(ctx,e.logger,lockFilePath)
230230

231231
outWriter,doneOut:=e.provisionLogWriter(logr)
@@ -289,14 +289,6 @@ func checksumFileCRC32(ctx context.Context, logger slog.Logger, path string) uin
289289
returncrc32.ChecksumIEEE(content)
290290
}
291291

292-
funcgetPlanFilePath(workdirstring)string {
293-
returnfilepath.Join(workdir,"terraform.tfplan")
294-
}
295-
296-
funcgetStateFilePath(workdirstring)string {
297-
returnfilepath.Join(workdir,"terraform.tfstate")
298-
}
299-
300292
// revive:disable-next-line:flag-parameter
301293
func (e*executor)plan(ctx,killCtx context.Context,env,vars []string,logrlogSink,req*proto.PlanRequest) (*proto.PlanComplete,error) {
302294
ctx,span:=e.server.startTrace(ctx,tracing.FuncName())
@@ -307,7 +299,7 @@ func (e *executor) plan(ctx, killCtx context.Context, env, vars []string, logr l
307299

308300
metadata:=req.Metadata
309301

310-
planfilePath:=getPlanFilePath(e.workdir)
302+
planfilePath:=e.files.PlanFilePath()
311303
args:= []string{
312304
"plan",
313305
"-no-color",
@@ -359,7 +351,7 @@ func (e *executor) plan(ctx, killCtx context.Context, env, vars []string, logr l
359351
// a workspace build. This removes some added costs of sending the modules
360352
// payload back to coderd if coderd is just going to ignore it.
361353
if!req.OmitModuleFiles {
362-
moduleFiles,err=GetModulesArchive(os.DirFS(e.workdir))
354+
moduleFiles,err=GetModulesArchive(os.DirFS(e.files.WorkDirectory()))
363355
iferr!=nil {
364356
// TODO: we probably want to persist this error or make it louder eventually
365357
e.logger.Warn(ctx,"failed to archive terraform modules",slog.Error(err))
@@ -551,7 +543,7 @@ func (e *executor) graph(ctx, killCtx context.Context) (string, error) {
551543
varout strings.Builder
552544
cmd:=exec.CommandContext(killCtx,e.binaryPath,args...)// #nosec
553545
cmd.Stdout=&out
554-
cmd.Dir=e.workdir
546+
cmd.Dir=e.files.WorkDirectory()
555547
cmd.Env=e.basicEnv()
556548

557549
e.server.logger.Debug(ctx,"executing terraform command graph",
@@ -588,7 +580,7 @@ func (e *executor) apply(
588580
"-auto-approve",
589581
"-input=false",
590582
"-json",
591-
getPlanFilePath(e.workdir),
583+
e.files.PlanFilePath(),
592584
}
593585

594586
outWriter,doneOut:=e.provisionLogWriter(logr)
@@ -608,7 +600,7 @@ func (e *executor) apply(
608600
iferr!=nil {
609601
returnnil,err
610602
}
611-
statefilePath:=getStateFilePath(e.workdir)
603+
statefilePath:=e.files.StateFilePath()
612604
stateContent,err:=os.ReadFile(statefilePath)
613605
iferr!=nil {
614606
returnnil,xerrors.Errorf("read statefile %q: %w",statefilePath,err)

‎provisioner/terraform/modules.go‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ import (
77
"io"
88
"io/fs"
99
"os"
10-
"path/filepath"
1110
"strings"
1211
"time"
1312

1413
"golang.org/x/xerrors"
1514

1615
"github.com/coder/coder/v2/coderd/util/xio"
1716
"github.com/coder/coder/v2/provisionersdk/proto"
17+
"github.com/coder/coder/v2/provisionersdk/tfpath"
1818
)
1919

2020
const (
@@ -39,10 +39,6 @@ type modulesFile struct {
3939
Modules []*module`json:"Modules"`
4040
}
4141

42-
funcgetModulesFilePath(workdirstring)string {
43-
returnfilepath.Join(workdir,".terraform","modules","modules.json")
44-
}
45-
4642
funcparseModulesFile(filePathstring) ([]*proto.Module,error) {
4743
modules:=&modulesFile{}
4844
data,err:=os.ReadFile(filePath)
@@ -62,8 +58,8 @@ func parseModulesFile(filePath string) ([]*proto.Module, error) {
6258
// getModules returns the modules from the modules file if it exists.
6359
// It returns nil if the file does not exist.
6460
// Modules become available after terraform init.
65-
funcgetModules(workdirstring) ([]*proto.Module,error) {
66-
filePath:=getModulesFilePath(workdir)
61+
funcgetModules(files tfpath.Layout) ([]*proto.Module,error) {
62+
filePath:=files.ModulesFilePath()
6763
if_,err:=os.Stat(filePath);os.IsNotExist(err) {
6864
returnnil,nil
6965
}

‎provisioner/terraform/parse.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,9 @@ func (s *server) Parse(sess *provisionersdk.Session, _ *proto.ParseRequest, _ <-
2525
deferspan.End()
2626

2727
// Load the module and print any parse errors.
28-
parser,diags:=tfparse.New(sess.WorkDirectory,tfparse.WithLogger(s.logger.Named("tfparse")))
28+
parser,diags:=tfparse.New(sess.Files.WorkDirectory(),tfparse.WithLogger(s.logger.Named("tfparse")))
2929
ifdiags.HasErrors() {
30-
returnprovisionersdk.ParseErrorf("load module: %s",formatDiagnostics(sess.WorkDirectory,diags))
30+
returnprovisionersdk.ParseErrorf("load module: %s",formatDiagnostics(sess.Files.WorkDirectory(),diags))
3131
}
3232

3333
workspaceTags,_,err:=parser.WorkspaceTags(ctx)

‎provisioner/terraform/provision.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ func (s *server) Plan(
7676
defercancel()
7777
deferkill()
7878

79-
e:=s.executor(sess.WorkDirectory,database.ProvisionerJobTimingStagePlan)
79+
e:=s.executor(sess.Files,database.ProvisionerJobTimingStagePlan)
8080
iferr:=e.checkMinVersion(ctx);err!=nil {
8181
returnprovisionersdk.PlanErrorf("%s",err.Error())
8282
}
@@ -92,7 +92,7 @@ func (s *server) Plan(
9292
return&proto.PlanComplete{}
9393
}
9494

95-
statefilePath:=getStateFilePath(sess.WorkDirectory)
95+
statefilePath:=sess.Files.StateFilePath()
9696
iflen(sess.Config.State)>0 {
9797
err:=os.WriteFile(statefilePath,sess.Config.State,0o600)
9898
iferr!=nil {
@@ -141,7 +141,7 @@ func (s *server) Plan(
141141
returnprovisionersdk.PlanErrorf("initialize terraform: %s",err)
142142
}
143143

144-
modules,err:=getModules(sess.WorkDirectory)
144+
modules,err:=getModules(sess.Files)
145145
iferr!=nil {
146146
// We allow getModules to fail, as the result is used only
147147
// for telemetry purposes now.
@@ -184,7 +184,7 @@ func (s *server) Apply(
184184
defercancel()
185185
deferkill()
186186

187-
e:=s.executor(sess.WorkDirectory,database.ProvisionerJobTimingStageApply)
187+
e:=s.executor(sess.Files,database.ProvisionerJobTimingStageApply)
188188
iferr:=e.checkMinVersion(ctx);err!=nil {
189189
returnprovisionersdk.ApplyErrorf("%s",err.Error())
190190
}
@@ -201,7 +201,7 @@ func (s *server) Apply(
201201
}
202202

203203
// Earlier in the session, Plan() will have written the state file and the plan file.
204-
statefilePath:=getStateFilePath(sess.WorkDirectory)
204+
statefilePath:=sess.Files.StateFilePath()
205205
env,err:=provisionEnv(sess.Config,request.Metadata,nil,nil,nil)
206206
iferr!=nil {
207207
returnprovisionersdk.ApplyErrorf("provision env: %s",err)
@@ -348,7 +348,7 @@ func logTerraformEnvVars(sink logSink) {
348348
// shipped in v1.0.4. It will return the stacktraces of the provider, which will hopefully allow us
349349
// to figure out why it hasn't exited.
350350
functryGettingCoderProviderStacktrace(sess*provisionersdk.Session)string {
351-
path:=filepath.Clean(filepath.Join(sess.WorkDirectory,"../.coder/pprof"))
351+
path:=filepath.Clean(filepath.Join(sess.Files.WorkDirectory(),"../.coder/pprof"))
352352
sess.Logger.Info(sess.Context(),"attempting to get stack traces",slog.F("path",path))
353353
c:= http.Client{
354354
Transport:&http.Transport{

‎provisioner/terraform/serve.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414
"golang.org/x/xerrors"
1515

1616
"cdr.dev/slog"
17+
"github.com/coder/coder/v2/provisionersdk/tfpath"
1718

1819
"github.com/coder/coder/v2/coderd/database"
1920
"github.com/coder/coder/v2/coderd/jobreaper"
@@ -160,14 +161,14 @@ func (s *server) startTrace(ctx context.Context, name string, opts ...trace.Span
160161
))...)
161162
}
162163

163-
func (s*server)executor(workdirstring,stage database.ProvisionerJobTimingStage)*executor {
164+
func (s*server)executor(files tfpath.Layout,stage database.ProvisionerJobTimingStage)*executor {
164165
return&executor{
165166
server:s,
166167
mut:s.execMut,
167168
binaryPath:s.binaryPath,
168169
cachePath:s.cachePath,
169170
cliConfigPath:s.cliConfigPath,
170-
workdir:workdir,
171+
files:files,
171172
logger:s.logger.Named("executor"),
172173
timings:newTimingAggregator(stage),
173174
}

‎provisionerd/provisionerd_test.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ func TestProvisionerd(t *testing.T) {
353353
_*sdkproto.ParseRequest,
354354
cancelOrComplete<-chanstruct{},
355355
)*sdkproto.ParseComplete {
356-
data,err:=os.ReadFile(filepath.Join(s.WorkDirectory,"test.txt"))
356+
data,err:=os.ReadFile(filepath.Join(s.Files,"test.txt"))
357357
require.NoError(t,err)
358358
require.Equal(t,"content",string(data))
359359
s.ProvisionLog(sdkproto.LogLevel_INFO,"hello")

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp