Git-Mirrors/constellation
1
0
Fork 0
mirror of https://github.com/edgelesssys/constellation.git synced 2025-05-05 07:45:27 -04:00
Code Issues Projects Releases Packages Wiki Activity

cli: refactor terraform code to be update/create agnostic (#2501)

Browse source 
* Move upgrade specific functions out of Terraform module
* Always allow overwriting Terraform files
* Ensure constellation-terraform dir does not exist on create

---------

Signed-off-by: Daniel Weiße <dw@edgeless.systems>
This commit is contained in:
Daniel Weiße 2023-10-26 10:55:50 +02:00 • committed by GitHub
parent f9989728f7
commit ec424b260d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
15 changed files with 158 additions and 322 deletions
Download patch file Download diff file Expand all files Collapse all files

60
cli/internal/terraform/loader.go
View file

@ -7,10 +7,8 @@ SPDX-License-Identifier: AGPL-3.0-only
package terraform
import (
"bytes"
"embed"
"errors"
"fmt"
"io/fs"
slashpath "path"
"path/filepath"
@ -20,44 +18,19 @@ import (
"github.com/spf13/afero"
)
// ErrTerraformWorkspaceDifferentFiles is returned when a re-used existing Terraform workspace has different files than the ones to be extracted (e.g. due to a version mix-up or incomplete writes).
var ErrTerraformWorkspaceDifferentFiles = errors.New("creating cluster: trying to overwrite an existing Terraform file with a different version")
//go:embed terraform/*
//go:embed terraform/*/.terraform.lock.hcl
//go:embed terraform/iam/*/.terraform.lock.hcl
var terraformFS embed.FS
const (
noOverwrites overwritePolicy = iota
allowOverwrites
)
type overwritePolicy int
// prepareWorkspace loads the embedded Terraform files,
// and writes them into the workspace.
func prepareWorkspace(rootDir string, fileHandler file.Handler, workingDir string) error {
return terraformCopier(fileHandler, rootDir, workingDir, noOverwrites)
}
// prepareUpgradeWorkspace backs up the old Terraform workspace from workingDir, and
// copies the embedded Terraform files into workingDir.
func prepareUpgradeWorkspace(rootDir string, fileHandler file.Handler, workingDir, backupDir string) error {
// backup old workspace
if err := fileHandler.CopyDir(
workingDir,
backupDir,
); err != nil {
return fmt.Errorf("backing up old workspace: %w", err)
}
return terraformCopier(fileHandler, rootDir, workingDir, allowOverwrites)
return terraformCopier(fileHandler, rootDir, workingDir)
}
// terraformCopier copies the embedded Terraform files into the workspace.
// allowOverwrites allows overwriting existing files in the workspace.
func terraformCopier(fileHandler file.Handler, rootDir, workingDir string, overwritePolicy overwritePolicy) error {
func terraformCopier(fileHandler file.Handler, rootDir, workingDir string) error {
goEmbedRootDir := filepath.ToSlash(rootDir)
return fs.WalkDir(terraformFS, goEmbedRootDir, func(path string, d fs.DirEntry, err error) error {
if err != nil {
@ -76,29 +49,14 @@ func terraformCopier(fileHandler file.Handler, rootDir, workingDir string, overw
fileName := strings.Replace(slashpath.Join(workingDir, path), goEmbedRootDir+"/", "", 1)
opts := []file.Option{
file.OptMkdirAll,
// Allow overwriting existing files.
// If we are creating a new cluster, the workspace must have been empty before,
// so there is no risk of overwriting existing files.
// If we are upgrading an existing cluster, we want to overwrite the existing files,
// and we have already created a backup of the existing workspace.
file.OptOverwrite,
}
if overwritePolicy == allowOverwrites {
opts = append(opts, file.OptOverwrite)
}
if err := fileHandler.Write(fileName, content, opts...); errors.Is(err, afero.ErrFileExists) {
// If a file already exists and overwritePolicy is set to noOverwrites,
// check if it is identical. If yes, continue and don't write anything to disk.
// If no, don't overwrite it and instead throw an error. The affected file could be from a different version,
// provider, corrupted or manually modified in general.
existingFileContent, err := fileHandler.Read(fileName)
if err != nil {
return err
}
if !bytes.Equal(content, existingFileContent) {
return ErrTerraformWorkspaceDifferentFiles
}
return nil
} else if err != nil {
return err
}
return nil
return fileHandler.Write(fileName, content, opts...)
})
}