Skip to content

feat: clean stale provisioner files #9545

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Sep 11, 2023
Merged

feat: clean stale provisioner files #9545

Changes from 1 commit
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
277d7c2
TODOs
mtojek Sep 5, 2023
afb0982
Remove stale session directories
mtojek Sep 6, 2023
1624453
Fix lint
mtojek Sep 6, 2023
4bd9a56
log errors
mtojek Sep 6, 2023
d395d02
use djherbis/times
mtojek Sep 6, 2023
e2c71f8
Stub for cleanStaleTerraformPlugins
mtojek Sep 6, 2023
19741fc
Review cached Terraform plugins
mtojek Sep 6, 2023
2af24c2
WIP access time
mtojek Sep 6, 2023
85a74cd
WIP
mtojek Sep 6, 2023
20bd67c
Implementation
mtojek Sep 7, 2023
905388b
lint
mtojek Sep 7, 2023
cd0c134
more fixes
mtojek Sep 7, 2023
7c8ca9f
polishing
mtojek Sep 7, 2023
574f084
move to cleanups
mtojek Sep 7, 2023
7aada74
fix stat
mtojek Sep 7, 2023
eabdacb
fix comment
mtojek Sep 7, 2023
1b49d80
WIP use afero
mtojek Sep 7, 2023
44e0517
Some golden files
mtojek Sep 7, 2023
18c5a1d
Polishing
mtojek Sep 7, 2023
2fdd756
Merge branch 'main' into 7107-clean-stale-files
mtojek Sep 7, 2023
b273cbf
make fmt
mtojek Sep 7, 2023
6c45602
fix: windows
mtojek Sep 7, 2023
b35f7a7
Fix
mtojek Sep 7, 2023
1cd5fc2
filepath.Join
mtojek Sep 7, 2023
662c32b
filepath.Join
mtojek Sep 7, 2023
4e6a09c
oh do not run on windows
mtojek Sep 7, 2023
ed2a8fd
Merge branch 'main' into 7107-clean-stale-files
mtojek Sep 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
polishing
  • Loading branch information
@mtojek
mtojek committed Sep 7, 2023
commit 7c8ca9ff208df41fd72465980b5afc66738fac93
13 changes: 9 additions & 4 deletions provisioner/terraform/provision.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ func (s *server) Plan(
}
}

err := cleanStaleTerraformPlugins(sess.Context(), s.cachePath, time.Now(), s.logger)
err := cleanStaleTerraformPlugins(sess.Context(), "/tmp/coder/provisioner-0/tf", time.Now(), s.logger)
if err != nil {
return provisionersdk.PlanErrorf("unable to clean stale Terraform plugins: %s", err)
}
Expand Down Expand Up @@ -264,6 +264,8 @@ func cleanStaleTerraformPlugins(ctx context.Context, cachePath string, now time.
return xerrors.Errorf("unable to determine absolute path %q: %w", cachePath, err)
}

logger.Info(ctx, "clean stale Terraform plugins", slog.F("cache_path", cachePath))

// Filter directory trees matching pattern: <repositoryURL>/<company>/<plugin>/<version>/<distribution>
filterFunc := func(path string, info os.FileInfo) bool {
if !info.IsDir() {
Expand All @@ -272,7 +274,7 @@ func cleanStaleTerraformPlugins(ctx context.Context, cachePath string, now time.

relativePath, err := filepath.Rel(cachePath, path)
if err != nil {
logger.Error(ctx, "unable to evaluate a relative path (base: %s, target: %s): %w", cachePath, path, err)
logger.Error(ctx, "unable to evaluate a relative path", slog.F("base", cachePath), slog.F("target", path), slog.Error(err))
return false
}

Expand All @@ -291,7 +293,7 @@ func cleanStaleTerraformPlugins(ctx context.Context, cachePath string, now time.
return nil
}

logger.Debug(ctx, "plugin directory discovered: %s", path)
logger.Debug(ctx, "plugin directory discovered", slog.F("path", path))
pluginPaths = append(pluginPaths, path)
return nil
})
Expand All @@ -308,7 +310,10 @@ func cleanStaleTerraformPlugins(ctx context.Context, cachePath string, now time.
}

if accessTime.Add(staleTerraformPluginRetention).Before(now) {
logger.Info(ctx, "plugin directory is stale and will be removed", slog.F("plugin_path", pluginPath))
stalePlugins = append(stalePlugins, pluginPath)
} else {
logger.Debug(ctx, "plugin directory is not stale", slog.F("plugin_path", pluginPath))
}
}

Expand Down Expand Up @@ -340,7 +345,7 @@ func cleanStaleTerraformPlugins(ctx context.Context, cachePath string, now time.
break // there are still other plugins
}

logger.Debug(ctx, "remove empty directory: %s", wd)
logger.Debug(ctx, "remove empty directory", slog.F("path", wd))
err = os.Remove(wd)
if err != nil {
return xerrors.Errorf("unable to remove directory %q: %w", wd, err)
Expand Down