Skip to content

feature: update observed generation on updateResource #731

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 2 commits into from
Dec 8, 2021
Merged

feature: update observed generation on updateResource #731

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0266b67
feature: update observed generation on updateResource
csviri Dec 2, 2021
e180777
fix: format
csviri Dec 2, 2021
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
3 changes: 3 additions & 0 deletions .../src/main/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,9 @@ private PostExecutionControl<R> reconcileExecution(ExecutionScope<R> executionSc
updatedCustomResource = updateStatusGenerationAware(updateControl.getResource());
} else if (updateControl.isUpdateResource()) {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't that if/else be simplified?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good question, could try magically transform this, but what I tried to achieve here is just break it down based on the return cases from the controller. So it's obvious what happens on those cases. If you have any suggestion pls let me know.

Copy link
Contributor

@heesuk-ahn heesuk-ahn Dec 10, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@csviri

If Enum is used to express Status in UpdateControl, it seems that if/else can be refactored 🤔 .

public class UpdateControl<T extends HasMetadata> extends BaseControl<UpdateControl<T>> {

  private final T resource;
  private final boolean updateStatus;
  private final boolean updateResource;
  private final UpdateControlStatusEnum controlStatusEnum; 
  ...

public enum UpdateControlStatusEnum {

  UPDATE_RESOURCE_AND_STATUS {
    @Override
    public <R extends HasMetadata> R toUpdatedResource(....) {
            return new UpdateResourceAndStatus(...);
        }
  },
  UPDATE_RESOURCE {
    @Override
    public <R extends HasMetadata> R toUpdatedResource(....) {
            return new UpdateResource(...);
        }
  },
  UPDATE_STATUS {
    @Override
    public <R extends HasMetadata> R toUpdatedResource(....) {
            return new UpdateStatus(...);
        }
  }
  
  // abstract method for business logic per status..
  // public abstract <R extends HasMetadata> R toUpdatedResource(...)
  
  // private static class UpdateResourceAndStatus implements UpdateCustomResource { .. }
  // private static class UpdateResource implements UpdateCustomResource { .. }
  // private static class UpdateStatus implements UpdateCustomResource { .. }
  // ...

Then in that class, you can use it like this:

class ReconciliationDispatcher<R extends HasMetadata> {
.
.
  private PostExecutionControl<R> reconcileExecution(ExecutionScope<R> executionScope,
      R resourceForExecution, R originalResource, Context context) {
   
    // REMOVED IF/ELSE...
    var updatedResource = updateControl.getControlStatusEnum.toUpdateResoruce(...);
    
    return createPostExecutionControl(updateResource, updateControl);
}

If refactoring is needed for this part, I think it can be improved in other issues and PullRequest. :)
Sorry for the late comment review!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be interested in seeing how this would work in a more fleshed-out PR, yes. Is that something you could work on, @heesuk-ahn?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@metacosm Yes, I will make an issue about this and work on it separately and upload the pr. :)

updatedCustomResource = updateCustomResource(updateControl.getResource());
if (shouldUpdateObservedGenerationAutomatically(updatedCustomResource)) {
updatedCustomResource = updateStatusGenerationAware(originalResource);
}
} else if (updateControl.isNoUpdate()
&& shouldUpdateObservedGenerationAutomatically(resourceForExecution)) {
updatedCustomResource = updateStatusGenerationAware(originalResource);
Expand Down
22 changes: 21 additions & 1 deletion .../test/java/io/javaoperatorsdk/operator/processing/event/ReconciliationDispatcherTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ public <R extends HasMetadata> R clone(R object) {
});
when(reconciler.cleanup(eq(customResource), any()))
.thenReturn(DeleteControl.defaultDelete());
when(customResourceFacade.replaceWithLock(any())).thenReturn(null);
Controller<R> controller =
new Controller<>(reconciler, configuration, null);

Expand Down Expand Up @@ -350,6 +349,27 @@ void updatesObservedGenerationOnNoUpdateUpdateControl() {
.isEqualTo(1L);
}

@Test
void updateObservedGenerationOnCustomResourceUpdate() {
var observedGenResource = createObservedGenCustomResource();

Reconciler<ObservedGenCustomResource> reconciler = mock(Reconciler.class);
ControllerConfiguration<ObservedGenCustomResource> config =
mock(ControllerConfiguration.class);
CustomResourceFacade<ObservedGenCustomResource> facade = mock(CustomResourceFacade.class);
when(config.isGenerationAware()).thenReturn(true);
when(reconciler.reconcile(any(), any()))
.thenReturn(UpdateControl.updateResource(observedGenResource));
when(facade.replaceWithLock(any())).thenReturn(observedGenResource);
when(facade.updateStatus(observedGenResource)).thenReturn(observedGenResource);
var dispatcher = init(observedGenResource, reconciler, config, facade);

PostExecutionControl<ObservedGenCustomResource> control = dispatcher.handleExecution(
executionScopeWithCREvent(observedGenResource));
assertThat(control.getUpdatedCustomResource().get().getStatus().getObservedGeneration())
.isEqualTo(1L);
}

@Test
void callErrorStatusHandlerIfImplemented() {
testCustomResource.addFinalizer(DEFAULT_FINALIZER);
Expand Down