-
Notifications
You must be signed in to change notification settings - Fork 24
issue 386 - handle cluster token overlap issue gracefully #387
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
Draft
msmygit
wants to merge
2
commits into
main
Choose a base branch
from
feat/handle_cluster_token_overlap_gracefully.md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 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
45 changes: 45 additions & 0 deletions
45
src/main/java/com/datastax/cdm/schema/ClusterConfigurationException.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,45 @@ | ||
| /* | ||
| * Copyright DataStax, Inc. | ||
| * | ||
| * Licensed 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 com.datastax.cdm.schema; | ||
|
|
||
| /** | ||
| * Exception thrown when there are issues with the Cassandra cluster configuration, such as token overlap problems or | ||
| * other metadata-related issues. | ||
| */ | ||
| public class ClusterConfigurationException extends RuntimeException { | ||
|
|
||
| /** | ||
| * Constructs a new exception with the specified detail message. | ||
| * | ||
| * @param message | ||
| * the detail message | ||
| */ | ||
| public ClusterConfigurationException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a new exception with the specified detail message and cause. | ||
| * | ||
| * @param message | ||
| * the detail message | ||
| * @param cause | ||
| * the cause of the exception | ||
| */ | ||
| public ClusterConfigurationException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
| } |
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
64 changes: 64 additions & 0 deletions
64
src/test/java/com/datastax/cdm/job/AbstractJobSessionErrorHandlingTest.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,64 @@ | ||
| /* | ||
| * Copyright DataStax, Inc. | ||
| * | ||
| * Licensed 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 com.datastax.cdm.job; | ||
|
|
||
| import static org.mockito.ArgumentMatchers.anyString; | ||
| import static org.mockito.ArgumentMatchers.eq; | ||
| import static org.mockito.Mockito.*; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.ExtendWith; | ||
| import org.mockito.Mock; | ||
| import org.mockito.junit.jupiter.MockitoExtension; | ||
| import org.slf4j.Logger; | ||
|
|
||
| import com.datastax.cdm.schema.ClusterConfigurationException; | ||
|
|
||
| @ExtendWith(MockitoExtension.class) | ||
| public class AbstractJobSessionErrorHandlingTest { | ||
|
|
||
| @Mock | ||
| private Logger mockLogger; | ||
|
|
||
| /** | ||
| * Simple test to verify error logging messages when ClusterConfigurationException is caught | ||
| */ | ||
| @Test | ||
| void testClusterConfigurationExceptionHandling() { | ||
| // Create an exception with a test message | ||
| ClusterConfigurationException tokenOverlapException = new ClusterConfigurationException( | ||
| "Token overlap detected in keyspace 'test'. This usually happens when multiple nodes were started simultaneously."); | ||
|
|
||
| // Log the appropriate error messages | ||
| mockLogger.error("Cluster configuration error detected: {}", tokenOverlapException.getMessage()); | ||
| mockLogger.error( | ||
| "Please check your Cassandra cluster for token overlap issues. This usually happens when multiple nodes in the cluster were started simultaneously."); | ||
| mockLogger.error( | ||
| "You can verify this by running 'nodetool describering <keyspace>' and checking for overlapping token ranges."); | ||
| mockLogger.error( | ||
| "To fix token overlap: 1) Restart nodes one at a time 2) Run nodetool cleanup on each node 3) Verify with nodetool describering"); | ||
|
|
||
| // Verify that the logger was called with the expected messages | ||
| // Without matcher, verify exact method calls | ||
| verify(mockLogger).error(eq("Cluster configuration error detected: {}"), anyString()); | ||
| verify(mockLogger).error(eq( | ||
| "Please check your Cassandra cluster for token overlap issues. This usually happens when multiple nodes in the cluster were started simultaneously.")); | ||
| verify(mockLogger).error(eq( | ||
| "You can verify this by running 'nodetool describering <keyspace>' and checking for overlapping token ranges.")); | ||
| verify(mockLogger).error(eq( | ||
| "To fix token overlap: 1) Restart nodes one at a time 2) Run nodetool cleanup on each node 3) Verify with nodetool describering")); | ||
| } | ||
| } |
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.
We will have to evaluate if this is same across different flavors of C* engines, e.g. OSS C*, DSE, HCD, Astra DB, etc.,