Skip to content

Commit e632182

Browse files
msmygitmsmygit
committed
Adding unit tests
1 parent 5f03be1 commit e632182

File tree

7 files changed

+387
-41
lines changed

7 files changed

+387
-41
lines changed

‎RELEASE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Release Notes
22

3+
## [5.6.0] - 2025-09-10
4+
- Added support for handling token collision scenario in the cluster and present users with an appropriate error message.
5+
36
## [5.5.1] - 2025-08-01
47
- Fixed issue related to empty text fields not getting migrated (introduced in 5.4.0). `Null` fields will still be skipped, however not empty strings.
58
- Filtered rows will now be logged at LOG4J `TRACE` level to avoid filling the logs. Users can enabled `TRACE` level logging if such logs are needed.

‎src/main/java/com/datastax/cdm/job/AbstractJobSession.java

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ protected AbstractJobSession(CqlSession originSession, CqlSession targetSession,
7878
for (Feature f : featureMap.values()) {
7979
if (!f.initializeAndValidate(cqlTableOrigin, cqlTableTarget)) {
8080
allFeaturesValid = false;
81-
logger.error("Feature {} is not valid. Please check the configuration.", f.getClass().getName());
81+
logger.error("Feature {} is not valid. Please check the configuration.",
82+
f.getClass().getName());
8283
}
8384
}
8485

@@ -99,9 +100,12 @@ protected AbstractJobSession(CqlSession originSession, CqlSession targetSession,
99100
}
100101
} catch (ClusterConfigurationException e) {
101102
logger.error("Cluster configuration error may be present & detected: {}", e.getMessage());
102-
logger.error("Please check your Cassandra cluster for token overlap issues. This usually happens when multiple nodes in the cluster were started simultaneously when the cluster was originally built.");
103-
logger.error("You can verify this by running 'nodetool describering <keyspace>' and checking for overlapping token ranges.");
104-
logger.error("In general, to fix token overlap in a cluster: 1) Rebuild the entire cluster by removing nodes 2) Re-add nodes one at a time 3) Run nodetool cleanup on each node 4) Verify with 'nodetool describering <keyspace>'");
103+
logger.error(
104+
"Please check your Cassandra cluster for token overlap issues. This usually happens when multiple nodes in the cluster were started simultaneously when the cluster was originally built.");
105+
logger.error(
106+
"You can verify this by running 'nodetool describering <keyspace>' and checking for overlapping token ranges.");
107+
logger.error(
108+
"In general, to fix token overlap in a cluster: 1) Rebuild the entire cluster by removing nodes 2) Re-add nodes one at a time 3) Run nodetool cleanup on each node 4) Verify with 'nodetool describering <keyspace>'");
105109
throw e;
106110
}
107111
}

‎src/main/java/com/datastax/cdm/schema/ClusterConfigurationException.java

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,28 @@
1616
package com.datastax.cdm.schema;
1717

1818
/**
19-
* Exception thrown when there are issues with the Cassandra cluster configuration,
20-
* such as token overlap problems or other metadata-related issues.
19+
* Exception thrown when there are issues with the Cassandra cluster configuration, such as token overlap problems or
20+
* other metadata-related issues.
2121
*/
2222
public class ClusterConfigurationException extends RuntimeException {
23-
23+
2424
/**
2525
* Constructs a new exception with the specified detail message.
2626
*
27-
* @param message the detail message
27+
* @param message
28+
* the detail message
2829
*/
2930
public ClusterConfigurationException(String message) {
3031
super(message);
3132
}
32-
33+
3334
/**
3435
* Constructs a new exception with the specified detail message and cause.
3536
*
36-
* @param message the detail message
37-
* @param cause the cause of the exception
37+
* @param message
38+
* the detail message
39+
* @param cause
40+
* the cause of the exception
3841
*/
3942
public ClusterConfigurationException(String message, Throwable cause) {
4043
super(message, cause);

‎src/main/java/com/datastax/cdm/schema/CqlTable.java

Lines changed: 53 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@
4646
import com.datastax.oss.driver.api.core.CqlSession;
4747
import com.datastax.oss.driver.api.core.cql.ResultSet;
4848
import com.datastax.oss.driver.api.core.cql.Row;
49-
import com.datastax.oss.driver.api.core.metadata.TokenMap;
5049
import com.datastax.oss.driver.api.core.metadata.Metadata;
50+
import com.datastax.oss.driver.api.core.metadata.TokenMap;
5151
import com.datastax.oss.driver.api.core.metadata.schema.ColumnMetadata;
5252
import com.datastax.oss.driver.api.core.metadata.schema.KeyspaceMetadata;
5353
import com.datastax.oss.driver.api.core.metadata.schema.TableMetadata;
@@ -435,32 +435,34 @@ protected Metadata fetchMetadataFromSession(CqlSession cqlSession) {
435435

436436
private void setCqlMetadata(CqlSession cqlSession) {
437437
Metadata metadata = fetchMetadataFromSession(cqlSession);
438-
438+
439439
// Check for token overlap in the specific keyspace
440-
if (hasTokenOverlap(cqlSession, this.keyspaceName)) {
441-
throw new ClusterConfigurationException(
442-
"Token overlap detected in keyspace '" + this.keyspaceName + "'. This usually happens when multiple nodes " +
443-
"were started simultaneously. To fix: 1) Restart nodes one at a time 2) Run 'nodetool cleanup' " +
444-
"on each node 3) Verify with 'nodetool describering " + this.keyspaceName + "'.");
440+
// Only run this check if the keyspace name is provided
441+
if (this.keyspaceName != null && !this.keyspaceName.isEmpty()
442+
&& hasTokenOverlap(cqlSession, this.keyspaceName)) {
443+
throw new ClusterConfigurationException("Token overlap detected in keyspace '" + this.keyspaceName
444+
+ "'. This usually happens when multiple nodes "
445+
+ "were started simultaneously. To fix: 1) Restart nodes one at a time 2) Run 'nodetool cleanup' "
446+
+ "on each node 3) Verify with 'nodetool describering " + this.keyspaceName + "'.");
445447
}
446-
448+
447449
// Add proper Optional handling for token map
448450
Optional<TokenMap> tokenMapOpt = metadata.getTokenMap();
449451
if (!tokenMapOpt.isPresent()) {
450452
throw new ClusterConfigurationException(
451-
"Token map is not available. This could indicate a cluster configuration issue.");
453+
"Token map is not available. This could indicate a cluster configuration issue.");
452454
}
453-
455+
454456
try {
455457
String partitionerName = tokenMapOpt.get().getPartitionerName();
456458
if (null != partitionerName && partitionerName.endsWith("RandomPartitioner"))
457459
this.hasRandomPartitioner = true;
458460
else
459461
this.hasRandomPartitioner = false;
460462
} catch (Exception e) {
461-
throw new ClusterConfigurationException(
462-
"Error accessing token map: " + e.getMessage() +
463-
". This may indicate token overlap in the Cassandra cluster. Check your cluster configuration.", e);
463+
throw new ClusterConfigurationException("Error accessing token map: " + e.getMessage()
464+
+ ". This may indicate token overlap in the Cassandra cluster. Check your cluster configuration.",
465+
e);
464466
}
465467

466468
Optional<KeyspaceMetadata> keyspaceMetadataOpt = metadata.getKeyspace(formatName(this.keyspaceName));
@@ -588,78 +590,99 @@ protected static ConsistencyLevel mapToConsistencyLevel(String level) {
588590

589591
return retVal;
590592
}
591-
593+
592594
/**
593595
* Checks if the specified keyspace has token overlap issues by querying the system.size_estimates table.
594-
*
595-
* @param cqlSession The CQL session to use for executing the query
596-
* @param keyspaceName The name of the keyspace to check
596+
*
597+
* @param cqlSession
598+
* The CQL session to use for executing the query
599+
* @param keyspaceName
600+
* The name of the keyspace to check
601+
*
597602
* @return true if token overlap is detected, false otherwise
598603
*/
599604
private boolean hasTokenOverlap(CqlSession cqlSession, String keyspaceName) {
605+
// Return false if either the session or keyspace name is null
606+
if (cqlSession == null || keyspaceName == null || keyspaceName.isEmpty()) {
607+
return false;
608+
}
609+
600610
try {
601611
// Execute query to check for token ranges for the specific keyspace
602612
String query = "SELECT start_token, end_token FROM system.size_estimates WHERE keyspace_name = ?";
603613
ResultSet rs = cqlSession.execute(query, keyspaceName);
604-
614+
615+
// Add null check for ResultSet to handle potential driver issues
616+
if (rs == null) {
617+
logger.warn("Unable to query system.size_estimates for keyspace {}: ResultSet is null", keyspaceName);
618+
return false;
619+
}
620+
605621
// Create a list to store token ranges for the keyspace
606622
List<TokenRange> ranges = new ArrayList<>();
607-
623+
608624
// Process the results
609625
for (Row row : rs) {
610626
BigInteger startToken = new BigInteger(row.getString("start_token"));
611627
BigInteger endToken = new BigInteger(row.getString("end_token"));
612628
ranges.add(new TokenRange(startToken, endToken));
613629
}
614-
630+
615631
// Check for overlaps
616632
if (hasOverlappingTokens(ranges)) {
617633
logger.error("Token overlap detected in keyspace: {}", keyspaceName);
618634
return true;
619635
}
620-
636+
621637
return false;
622638
} catch (Exception e) {
623639
logger.warn("Could not check for token overlap in keyspace {}: {}", keyspaceName, e.getMessage());
624640
return false;
625641
}
626642
}
627-
643+
628644
/**
629645
* Determines if there are overlapping token ranges in the provided list.
630-
*
631-
* @param ranges List of token ranges to check
646+
*
647+
* @param ranges
648+
* List of token ranges to check
649+
*
632650
* @return true if any ranges overlap, false otherwise
633651
*/
634652
private boolean hasOverlappingTokens(List<TokenRange> ranges) {
653+
// Return false if ranges is null or empty (no overlap possible)
654+
if (ranges == null || ranges.isEmpty() || ranges.size() < 2) {
655+
return false;
656+
}
657+
635658
// Sort ranges by start token
636659
Collections.sort(ranges);
637-
660+
638661
// Check for overlaps
639662
for (int i = 0; i < ranges.size() - 1; i++) {
640663
TokenRange current = ranges.get(i);
641664
TokenRange next = ranges.get(i + 1);
642-
665+
643666
if (current.endToken.compareTo(next.startToken) > 0) {
644667
return true;
645668
}
646669
}
647-
670+
648671
return false;
649672
}
650-
673+
651674
/**
652675
* Helper class to represent a token range with Comparable implementation for sorting.
653676
*/
654677
private static class TokenRange implements Comparable<TokenRange> {
655678
BigInteger startToken;
656679
BigInteger endToken;
657-
680+
658681
TokenRange(BigInteger startToken, BigInteger endToken) {
659682
this.startToken = startToken;
660683
this.endToken = endToken;
661684
}
662-
685+
663686
@Override
664687
public int compareTo(TokenRange other) {
665688
return this.startToken.compareTo(other.startToken);

‎src/test/java/com/datastax/cdm/job/AbstractJobSessionErrorHandlingTest.java

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
/*
2+
* Copyright DataStax, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.datastax.cdm.job;
17+
18+
import static org.mockito.ArgumentMatchers.anyString;
19+
import static org.mockito.ArgumentMatchers.eq;
20+
import static org.mockito.Mockito.*;
21+
22+
import org.junit.jupiter.api.Test;
23+
import org.junit.jupiter.api.extension.ExtendWith;
24+
import org.mockito.Mock;
25+
import org.mockito.junit.jupiter.MockitoExtension;
26+
import org.slf4j.Logger;
27+
28+
import com.datastax.cdm.schema.ClusterConfigurationException;
29+
30+
@ExtendWith(MockitoExtension.class)
31+
public class AbstractJobSessionErrorHandlingTest {
32+
33+
@Mock
34+
private Logger mockLogger;
35+
36+
/**
37+
* Simple test to verify error logging messages when ClusterConfigurationException is caught
38+
*/
39+
@Test
40+
void testClusterConfigurationExceptionHandling() {
41+
// Create an exception with a test message
42+
ClusterConfigurationException tokenOverlapException = new ClusterConfigurationException(
43+
"Token overlap detected in keyspace 'test'. This usually happens when multiple nodes were started simultaneously.");
44+
45+
// Log the appropriate error messages
46+
mockLogger.error("Cluster configuration error detected: {}", tokenOverlapException.getMessage());
47+
mockLogger.error(
48+
"Please check your Cassandra cluster for token overlap issues. This usually happens when multiple nodes in the cluster were started simultaneously.");
49+
mockLogger.error(
50+
"You can verify this by running 'nodetool describering <keyspace>' and checking for overlapping token ranges.");
51+
mockLogger.error(
52+
"To fix token overlap: 1) Restart nodes one at a time 2) Run nodetool cleanup on each node 3) Verify with nodetool describering");
53+
54+
// Verify that the logger was called with the expected messages
55+
// Without matcher, verify exact method calls
56+
verify(mockLogger).error(eq("Cluster configuration error detected: {}"), anyString());
57+
verify(mockLogger).error(eq(
58+
"Please check your Cassandra cluster for token overlap issues. This usually happens when multiple nodes in the cluster were started simultaneously."));
59+
verify(mockLogger).error(eq(
60+
"You can verify this by running 'nodetool describering <keyspace>' and checking for overlapping token ranges."));
61+
verify(mockLogger).error(eq(
62+
"To fix token overlap: 1) Restart nodes one at a time 2) Run nodetool cleanup on each node 3) Verify with nodetool describering"));
63+
}
64+
}

‎src/test/java/com/datastax/cdm/schema/ClusterConfigurationExceptionTest.java

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
/*
2+
* Copyright DataStax, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.datastax.cdm.schema;
17+
18+
import static org.junit.jupiter.api.Assertions.assertEquals;
19+
import static org.junit.jupiter.api.Assertions.assertThrows;
20+
import static org.mockito.ArgumentMatchers.any;
21+
import static org.mockito.ArgumentMatchers.anyString;
22+
import static org.mockito.ArgumentMatchers.eq;
23+
import static org.mockito.Mockito.mock;
24+
import static org.mockito.Mockito.when;
25+
26+
import java.util.Optional;
27+
28+
import org.junit.jupiter.api.Test;
29+
30+
public class ClusterConfigurationExceptionTest {
31+
32+
@Test
33+
void testExceptionConstructor() {
34+
String errorMessage = "Test error message";
35+
ClusterConfigurationException exception = new ClusterConfigurationException(errorMessage);
36+
assertEquals(errorMessage, exception.getMessage());
37+
38+
Exception cause = new RuntimeException("Test cause");
39+
ClusterConfigurationException exceptionWithCause = new ClusterConfigurationException(errorMessage, cause);
40+
assertEquals(errorMessage, exceptionWithCause.getMessage());
41+
assertEquals(cause, exceptionWithCause.getCause());
42+
}
43+
}

0 commit comments

Comments
 (0)