Skip to content

Commit d15691c

Browse files
akurinnoyakurinnoy
committed
fix: rename controller
Signed-off-by: Oleksii Kurinnyi <[email protected]>
1 parent 11916fb commit d15691c

File tree

4 files changed

+23
-23
lines changed

4 files changed

+23
-23
lines changed

controllers/pruner/pruner_controller.go renamed to controllers/cleanupcronjob/cleanupcronjob_controller.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ import (
4242
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
4343
)
4444

45-
// DevWorkspacePrunerReconciler reconciles DevWorkspace objects for pruning purposes.
46-
type DevWorkspacePrunerReconciler struct {
45+
// CleanupCronJobReconciler reconciles `CleanupCronJob` configuration for the purpose of pruning stale DevWorkspaces.
46+
type CleanupCronJobReconciler struct {
4747
client.Client
4848
Log logr.Logger
4949
Scheme *runtime.Scheme
@@ -105,9 +105,9 @@ func shouldReconcileOnUpdate(e event.UpdateEvent, log logr.Logger) bool {
105105
}
106106

107107
// SetupWithManager sets up the controller with the Manager.
108-
func (r *DevWorkspacePrunerReconciler) SetupWithManager(mgr ctrl.Manager) error {
108+
func (r *CleanupCronJobReconciler) SetupWithManager(mgr ctrl.Manager) error {
109109
log := r.Log.WithName("setupWithManager")
110-
log.Info("Setting up DevWorkspacePrunerReconciler")
110+
log.Info("Setting up CleanupCronJobReconciler")
111111

112112
configPredicate := predicate.Funcs{
113113
UpdateFunc: func(e event.UpdateEvent) bool {
@@ -122,7 +122,7 @@ func (r *DevWorkspacePrunerReconciler) SetupWithManager(mgr ctrl.Manager) error
122122
r.cron = cron.New()
123123

124124
return ctrl.NewControllerManagedBy(mgr).
125-
Named("DevWorkspacePruner").
125+
Named("CleanupCronJob").
126126
Watches(&source.Kind{Type: &controllerv1alpha1.DevWorkspaceOperatorConfig{}},
127127
handler.EnqueueRequestsFromMapFunc(func(object client.Object) []ctrl.Request {
128128
operatorNamespace, err := infrastructure.GetNamespace()
@@ -150,10 +150,10 @@ func (r *DevWorkspacePrunerReconciler) SetupWithManager(mgr ctrl.Manager) error
150150
// +kubebuilder:rbac:groups=workspace.devfile.io,resources=devworkspaces,verbs=get;list;delete
151151
// +kubebuilder:rbac:groups=controller.devfile.io,resources=devworkspaceoperatorconfigs,verbs=get;list;watch
152152

153-
// Reconcile is the main reconciliation loop for the pruner controller.
154-
func (r *DevWorkspacePrunerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
153+
// Reconcile is the main reconciliation loop for the CleanupCronJob controller.
154+
func (r *CleanupCronJobReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
155155
log := r.Log
156-
log.Info("Reconciling DevWorkspacePruner", "DWOC", req.NamespacedName)
156+
log.Info("Reconciling CleanupCronJob", "DWOC", req.NamespacedName)
157157

158158
dwOperatorConfig := &controllerv1alpha1.DevWorkspaceOperatorConfig{}
159159
err := r.Get(ctx, req.NamespacedName, dwOperatorConfig)
@@ -187,7 +187,7 @@ func (r *DevWorkspacePrunerReconciler) Reconcile(ctx context.Context, req ctrl.R
187187
return ctrl.Result{}, nil
188188
}
189189

190-
func (r *DevWorkspacePrunerReconciler) startCron(ctx context.Context, cleanupConfig *controllerv1alpha1.CleanupCronJobConfig, logger logr.Logger) {
190+
func (r *CleanupCronJobReconciler) startCron(ctx context.Context, cleanupConfig *controllerv1alpha1.CleanupCronJobConfig, logger logr.Logger) {
191191
log := logger.WithName("cron")
192192
log.Info("Starting cron scheduler")
193193

@@ -224,7 +224,7 @@ func (r *DevWorkspacePrunerReconciler) startCron(ctx context.Context, cleanupCon
224224
r.cron.Start()
225225
}
226226

227-
func (r *DevWorkspacePrunerReconciler) stopCron(logger logr.Logger) {
227+
func (r *CleanupCronJobReconciler) stopCron(logger logr.Logger) {
228228
log := logger.WithName("cron")
229229
log.Info("Stopping cron scheduler")
230230

@@ -240,7 +240,7 @@ func (r *DevWorkspacePrunerReconciler) stopCron(logger logr.Logger) {
240240
log.Info("Cron scheduler stopped")
241241
}
242242

243-
func (r *DevWorkspacePrunerReconciler) pruneDevWorkspaces(ctx context.Context, retainTime time.Duration, dryRun bool, logger logr.Logger) error {
243+
func (r *CleanupCronJobReconciler) pruneDevWorkspaces(ctx context.Context, retainTime time.Duration, dryRun bool, logger logr.Logger) error {
244244
log := logger.WithName("pruner")
245245

246246
// create a prune strategy based on the configuration
@@ -283,7 +283,7 @@ func (r *DevWorkspacePrunerReconciler) pruneDevWorkspaces(ctx context.Context, r
283283

284284
// pruneStrategy returns a StrategyFunc that will return a list of
285285
// DevWorkspaces to prune based on the lastTransitionTime of the 'Started' condition.
286-
func (r *DevWorkspacePrunerReconciler) pruneStrategy(retainTime time.Duration, logger logr.Logger) prune.StrategyFunc {
286+
func (r *CleanupCronJobReconciler) pruneStrategy(retainTime time.Duration, logger logr.Logger) prune.StrategyFunc {
287287
log := logger.WithName("pruneStrategy")
288288

289289
return func(ctx context.Context, objs []client.Object) ([]client.Object, error) {
@@ -295,7 +295,7 @@ func (r *DevWorkspacePrunerReconciler) pruneStrategy(retainTime time.Duration, l
295295

296296
// dryRunPruneStrategy returns a StrategyFunc that will always return an empty list of DevWorkspaces to prune.
297297
// This is used for dry-run mode.
298-
func (r *DevWorkspacePrunerReconciler) dryRunPruneStrategy(retainTime time.Duration, logger logr.Logger) prune.StrategyFunc {
298+
func (r *CleanupCronJobReconciler) dryRunPruneStrategy(retainTime time.Duration, logger logr.Logger) prune.StrategyFunc {
299299
log := logger.WithName("dryRunPruneStrategy")
300300

301301
return func(ctx context.Context, objs []client.Object) ([]client.Object, error) {

controllers/pruner/pruner_controller_test.go renamed to controllers/cleanupcronjob/cleanupcronjob_controller_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ import (
4040
"sigs.k8s.io/controller-runtime/pkg/predicate"
4141
)
4242

43-
var _ = Describe("DevWorkspacePrunerReconciler", func() {
43+
var _ = Describe("CleanupCronJobReconciler", func() {
4444
var (
4545
ctx context.Context
4646
fakeClient client.Client
47-
reconciler DevWorkspacePrunerReconciler
47+
reconciler CleanupCronJobReconciler
4848
nameNamespace types.NamespacedName
4949
log logr.Logger
5050
)
@@ -55,9 +55,9 @@ var _ = Describe("DevWorkspacePrunerReconciler", func() {
5555
Expect(controllerv1alpha1.AddToScheme(scheme)).To(Succeed())
5656
Expect(dwv2.AddToScheme(scheme)).To(Succeed())
5757
fakeClient = fake.NewClientBuilder().WithScheme(scheme).Build()
58-
log = zap.New(zap.UseDevMode(true)).WithName("prunerController")
58+
log = zap.New(zap.UseDevMode(true)).WithName("cleanupCronJobController")
5959

60-
reconciler = DevWorkspacePrunerReconciler{
60+
reconciler = CleanupCronJobReconciler{
6161
Client: fakeClient,
6262
Log: log,
6363
Scheme: scheme,

controllers/pruner/suite_test.go renamed to controllers/cleanupcronjob/suite_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
. "github.com/onsi/gomega"
2121
)
2222

23-
func TestPruner(t *testing.T) {
23+
func TestAPIs(t *testing.T) {
2424
RegisterFailHandler(Fail)
25-
RunSpecs(t, "Pruner Suite")
25+
RunSpecs(t, "CleanupCronJob Controller Suite")
2626
}

‎main.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import (
3535
dwv2 "github.com/devfile/api/v2/pkg/apis/workspaces/v1alpha2"
3636

3737
controllerv1alpha1 "github.com/devfile/devworkspace-operator/apis/controller/v1alpha1"
38-
prunercontroller "github.com/devfile/devworkspace-operator/controllers/pruner"
38+
"github.com/devfile/devworkspace-operator/controllers/pruner"
3939
workspacecontroller "github.com/devfile/devworkspace-operator/controllers/workspace"
4040

4141
configv1 "github.com/openshift/api/config/v1"
@@ -170,12 +170,12 @@ func main() {
170170
setupLog.Error(err, "unable to create controller", "controller", "DevWorkspace")
171171
os.Exit(1)
172172
}
173-
if err = (&prunercontroller.DevWorkspacePrunerReconciler{
173+
if err = (&controllers.CleanupCronJobReconciler{
174174
Client: mgr.GetClient(),
175-
Log: ctrl.Log.WithName("controllers").WithName("DevWorkspacePruner"),
175+
Log: ctrl.Log.WithName("controllers").WithName("CleanupCronJob"),
176176
Scheme: mgr.GetScheme(),
177177
}).SetupWithManager(mgr); err != nil {
178-
setupLog.Error(err, "unable to create controller", "controller", "DevWorkspacePruner")
178+
setupLog.Error(err, "unable to create controller", "controller", "CleanupCronJob")
179179
os.Exit(1)
180180
}
181181
// +kubebuilder:scaffold:builder

0 commit comments

Comments
 (0)