Stub for cleanStaleTerraformPlugins

coder · mtojek · Sep 11, 2023 · Sep 5, 2023 · Sep 6, 2023 · Sep 6, 2023
commit e2c71f87a7589fa4e3d4f381d40adc254a3753d7
diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -89,10 +89,13 @@ func (s *server) Plan(
 		}
 	}
 
-	// TODO Clean stale TF files
+	err := cleanStaleTerraformPlugins(sess.Context(), s.cachePath, time.Now(), s.logger)
+	if err != nil {
+		return provisionersdk.PlanErrorf("unable to clean stale Terraform plugins: %s", err)
+	}
 
 	s.logger.Debug(ctx, "running initialization")
-	err := e.init(ctx, killCtx, sess)
+	err = e.init(ctx, killCtx, sess)
 	if err != nil {
 		s.logger.Debug(ctx, "init failed", slog.Error(err))
 		return provisionersdk.PlanErrorf("initialize terraform: %s", err)
@@ -241,3 +244,25 @@ func logTerraformEnvVars(sink logSink) {
 		}
 	}
 }
+
+// cleanStaleTerraformPlugins browses the Terraform cache directory
+// and remove stale plugins that haven't been used for a while.
+//
+// Additionally, it sweeps empty, old directory trees.
+//
+// Sample cachePath: /Users/<username>/Library/Caches/coder/provisioner-<N>/tf
+func cleanStaleTerraformPlugins(ctx context.Context, cachePath string, now time.Time, logger slog.Logger) error {
+	// Review cached Terraform plugins
+	// TODO
+
+	// Identify stale plugins
+	// TODO
+
+	// Remove stale plugins
+	// TODO
+
+	// Maintain the directory tree
+	// TODO
+
+	return nil
+}
diff --git a/provisionersdk/session.go b/provisionersdk/session.go
@@ -43,7 +43,7 @@ func (p *protoServer) Session(stream proto.DRPCProvisioner_SessionStream) error
 
 	err := cleanStaleSessions(s.Context(), p.opts.WorkDirectory, time.Now(), s.Logger)
 	if err != nil {
-		return xerrors.Errorf("clean stale sessions %q: %w", s.WorkDirectory, err)
+		return xerrors.Errorf("unable to clean stale sessions %q: %w", s.WorkDirectory, err)
 	}
 
 	s.WorkDirectory = filepath.Join(p.opts.WorkDirectory, sessionDir(sessID))
@@ -327,6 +327,9 @@ func (r *request[R, C]) do() (C, error) {
 	}
 }
 
+// cleanStaleSessions browses the work directory searching for stale session
+// directories. Coder provisioner is supposed to remove them once after finishing the provisioning,
+// but there is a risk of keeping them in case of a failure.
 func cleanStaleSessions(ctx context.Context, workDirectory string, now time.Time, logger slog.Logger) error {
 	entries, err := os.ReadDir(workDirectory)
 	if err != nil {