-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Fix compaction status API response #17006
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.
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
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
232 changes: 232 additions & 0 deletions
232
...src/test/java/org/apache/druid/indexing/overlord/http/OverlordCompactionResourceTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,232 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.druid.indexing.overlord.http; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import org.apache.druid.error.DruidException; | ||
| import org.apache.druid.error.DruidExceptionMatcher; | ||
| import org.apache.druid.error.ErrorResponse; | ||
| import org.apache.druid.indexing.compact.CompactionScheduler; | ||
| import org.apache.druid.segment.TestDataSource; | ||
| import org.apache.druid.server.compaction.CompactionProgressResponse; | ||
| import org.apache.druid.server.compaction.CompactionStatistics; | ||
| import org.apache.druid.server.compaction.CompactionStatusResponse; | ||
| import org.apache.druid.server.coordinator.AutoCompactionSnapshot; | ||
| import org.apache.druid.server.coordinator.CompactionSupervisorConfig; | ||
| import org.easymock.EasyMock; | ||
| import org.hamcrest.MatcherAssert; | ||
| import org.junit.After; | ||
| import org.junit.Assert; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| import javax.ws.rs.core.Response; | ||
| import java.util.Collections; | ||
| import java.util.Map; | ||
|
|
||
| public class OverlordCompactionResourceTest | ||
| { | ||
| private static final CompactionSupervisorConfig SUPERVISOR_ENABLED | ||
| = new CompactionSupervisorConfig(true); | ||
| private static final CompactionSupervisorConfig SUPERVISOR_DISABLED | ||
| = new CompactionSupervisorConfig(false); | ||
|
|
||
| private CompactionScheduler scheduler; | ||
|
|
||
| @Before | ||
| public void setUp() | ||
| { | ||
| scheduler = EasyMock.createStrictMock(CompactionScheduler.class); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() | ||
| { | ||
| EasyMock.verify(scheduler); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetCompactionSnapshotWithEmptyDatasource() | ||
| { | ||
| final Map<String, AutoCompactionSnapshot> allSnapshots = ImmutableMap.of( | ||
| TestDataSource.WIKI, | ||
| AutoCompactionSnapshot.builder(TestDataSource.WIKI).build() | ||
| ); | ||
|
|
||
| EasyMock.expect(scheduler.getAllCompactionSnapshots()) | ||
| .andReturn(allSnapshots).once(); | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionSnapshots(""); | ||
| Assert.assertEquals(200, response.getStatus()); | ||
| Assert.assertEquals( | ||
| new CompactionStatusResponse(allSnapshots.values()), | ||
| response.getEntity() | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetCompactionSnapshotWithNullDatasource() | ||
| { | ||
| final Map<String, AutoCompactionSnapshot> allSnapshots = ImmutableMap.of( | ||
| TestDataSource.WIKI, | ||
| AutoCompactionSnapshot.builder(TestDataSource.WIKI).build() | ||
| ); | ||
|
|
||
| EasyMock.expect(scheduler.getAllCompactionSnapshots()) | ||
| .andReturn(allSnapshots).once(); | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionSnapshots(null); | ||
| Assert.assertEquals(200, response.getStatus()); | ||
| Assert.assertEquals( | ||
| new CompactionStatusResponse(allSnapshots.values()), | ||
| response.getEntity() | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetCompactionSnapshotWithValidDatasource() | ||
| { | ||
| final AutoCompactionSnapshot snapshot = AutoCompactionSnapshot.builder(TestDataSource.WIKI).build(); | ||
|
|
||
| EasyMock.expect(scheduler.getCompactionSnapshot(TestDataSource.WIKI)) | ||
| .andReturn(snapshot).once(); | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionSnapshots(TestDataSource.WIKI); | ||
| Assert.assertEquals(200, response.getStatus()); | ||
| Assert.assertEquals( | ||
| new CompactionStatusResponse(Collections.singleton(snapshot)), | ||
| response.getEntity() | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetCompactionSnapshotWithInvalidDatasource() | ||
| { | ||
| EasyMock.expect(scheduler.getCompactionSnapshot(TestDataSource.KOALA)) | ||
| .andReturn(null).once(); | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionSnapshots(TestDataSource.KOALA); | ||
| Assert.assertEquals(404, response.getStatus()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetProgressForValidDatasource() | ||
| { | ||
| final AutoCompactionSnapshot.Builder snapshotBuilder | ||
| = AutoCompactionSnapshot.builder(TestDataSource.WIKI); | ||
| snapshotBuilder.incrementWaitingStats(CompactionStatistics.create(100L, 10L, 1L)); | ||
| final AutoCompactionSnapshot snapshot = snapshotBuilder.build(); | ||
|
|
||
| EasyMock.expect(scheduler.getCompactionSnapshot(TestDataSource.WIKI)) | ||
| .andReturn(snapshot).once(); | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionProgress(TestDataSource.WIKI); | ||
| Assert.assertEquals(200, response.getStatus()); | ||
| Assert.assertEquals(new CompactionProgressResponse(100L), response.getEntity()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetProgressForNullDatasourceReturnsBadRequest() | ||
| { | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionProgress(null); | ||
| Assert.assertEquals(Response.Status.BAD_REQUEST.getStatusCode(), response.getStatus()); | ||
|
|
||
| final Object responseEntity = response.getEntity(); | ||
| Assert.assertTrue(responseEntity instanceof ErrorResponse); | ||
|
|
||
| MatcherAssert.assertThat( | ||
| ((ErrorResponse) responseEntity).getUnderlyingException(), | ||
| DruidExceptionMatcher.invalidInput().expectMessageIs("No DataSource specified") | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetProgressForInvalidDatasourceReturnsNotFound() | ||
| { | ||
| EasyMock.expect(scheduler.getCompactionSnapshot(TestDataSource.KOALA)) | ||
| .andReturn(null).once(); | ||
| EasyMock.replay(scheduler); | ||
|
|
||
| final Response response = new OverlordCompactionResource(SUPERVISOR_ENABLED, scheduler) | ||
| .getCompactionProgress(TestDataSource.KOALA); | ||
| Assert.assertEquals(Response.Status.NOT_FOUND.getStatusCode(), response.getStatus()); | ||
|
|
||
| final Object responseEntity = response.getEntity(); | ||
| Assert.assertTrue(responseEntity instanceof ErrorResponse); | ||
|
|
||
| MatcherAssert.assertThat( | ||
| ((ErrorResponse) responseEntity).getUnderlyingException(), | ||
| DruidExceptionMatcher.notFound().expectMessageIs("Unknown DataSource") | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetProgressReturnsUnsupportedWhenSupervisorDisabled() | ||
| { | ||
| EasyMock.replay(scheduler); | ||
| verifyResponseWhenSupervisorDisabled( | ||
| new OverlordCompactionResource(SUPERVISOR_DISABLED, scheduler) | ||
| .getCompactionProgress(TestDataSource.WIKI) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetSnapshotReturnsUnsupportedWhenSupervisorDisabled() | ||
| { | ||
| EasyMock.replay(scheduler); | ||
| verifyResponseWhenSupervisorDisabled( | ||
| new OverlordCompactionResource(SUPERVISOR_DISABLED, scheduler) | ||
| .getCompactionSnapshots(TestDataSource.WIKI) | ||
| ); | ||
| } | ||
|
|
||
| private void verifyResponseWhenSupervisorDisabled(Response response) | ||
| { | ||
| Assert.assertEquals(501, response.getStatus()); | ||
|
|
||
| final Object responseEntity = response.getEntity(); | ||
| Assert.assertTrue(responseEntity instanceof ErrorResponse); | ||
|
|
||
| MatcherAssert.assertThat( | ||
| ((ErrorResponse) responseEntity).getUnderlyingException(), | ||
| new DruidExceptionMatcher( | ||
| DruidException.Persona.USER, | ||
| DruidException.Category.UNSUPPORTED, | ||
| "general" | ||
| ).expectMessageIs( | ||
| "Compaction Supervisors are disabled on the Overlord." | ||
| + " Use Coordinator APIs to fetch compaction status." | ||
| ) | ||
| ); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason that raw map isn't compatible but a class works? I believe both would be serialised in the same manner.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that's true. The problem wasn't that I had used a map instead of a dedicated POJO. Instead, I had forgotten to use anything at all 😛 .
The Overlord REST endpoint returns a response that looks like
but in the Overlord client, I was just reading the internal list
instead of the whole object.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to avoid such mistakes in the future and to keep the code simple, I decided to use a model POJO instead of maps everywhere.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree. Makes it so much cleaner.