Skip to content

Revise javadoc and test cases of DatabaseRuleNodeProvider #34776

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
terrymanu merged 2 commits into from
Feb 24, 2025
Merged

Revise javadoc and test cases of DatabaseRuleNodeProvider #34776

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
cd71c09
Revise javadoc of DatabaseRuleNodeProvider
terrymanu Feb 24, 2025
b7cc0ba
Rename test cases
terrymanu Feb 24, 2025
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
2 changes: 1 addition & 1 deletion ...java/org/apache/shardingsphere/broadcast/metadata/nodepath/BroadcastRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import java.util.Collections;

/**
* Broadcast rule node path provider.
* Broadcast rule node provider.
*/
public final class BroadcastRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...th/BroadcastRuleNodePathProviderTest.java → ...depath/BroadcastRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

class BroadcastRuleNodePathProviderTest {
class BroadcastRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, BroadcastRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, BroadcastRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertTrue(actual.getNamedItems().isEmpty());
assertThat(actual.getUniqueItems().size(), is(1));
assertTrue(actual.getUniqueItems().containsKey(BroadcastRuleNodeProvider.TABLES));
Expand Down
2 changes: 1 addition & 1 deletion ...ain/java/org/apache/shardingsphere/encrypt/metadata/nodepath/EncryptRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import java.util.Collections;

/**
* Encrypt rule node path provider.
* Encrypt rule node provider.
*/
public final class EncryptRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...path/EncryptRuleNodePathProviderTest.java → ...nodepath/EncryptRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

class EncryptRuleNodePathProviderTest {
class EncryptRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, EncryptRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, EncryptRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertThat(actual.getNamedItems().size(), is(2));
assertTrue(actual.getNamedItems().containsKey(EncryptRuleNodeProvider.ENCRYPTORS));
assertTrue(actual.getNamedItems().containsKey(EncryptRuleNodeProvider.TABLES));
Expand Down
2 changes: 1 addition & 1 deletion .../src/main/java/org/apache/shardingsphere/mask/metadata/nodepath/MaskRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import java.util.Collections;

/**
* Mask rule node path provider.
* Mask rule node provider.
*/
public final class MaskRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...odepath/MaskRuleNodePathProviderTest.java → ...ta/nodepath/MaskRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

class MaskRuleNodePathProviderTest {
class MaskRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, MaskRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, MaskRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertThat(actual.getNamedItems().size(), is(2));
assertTrue(actual.getNamedItems().containsKey(MaskRuleNodeProvider.MASK_ALGORITHMS));
assertTrue(actual.getNamedItems().containsKey(MaskRuleNodeProvider.TABLES));
Expand Down
2 changes: 1 addition & 1 deletion ...ardingsphere/readwritesplitting/metadata/nodepath/ReadwriteSplittingRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import java.util.Collections;

/**
* Readwrite-splitting rule node path provider.
* Readwrite-splitting rule node provider.
*/
public final class ReadwriteSplittingRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...iteSplittingRuleNodePathProviderTest.java → ...adwriteSplittingRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

class ReadwriteSplittingRuleNodePathProviderTest {
class ReadwriteSplittingRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, ReadwriteSplittingRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, ReadwriteSplittingRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertThat(actual.getNamedItems().size(), is(2));
assertTrue(actual.getNamedItems().containsKey(ReadwriteSplittingRuleNodeProvider.DATA_SOURCE_GROUPS));
assertTrue(actual.getNamedItems().containsKey(ReadwriteSplittingRuleNodeProvider.LOAD_BALANCERS));
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/org/apache/shardingsphere/shadow/metadata/nodepath/ShadowRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import java.util.Collections;

/**
* Shadow rule node path provider.
* Shadow rule node provider.
*/
public final class ShadowRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...epath/ShadowRuleNodePathProviderTest.java → .../nodepath/ShadowRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

class ShadowRuleNodePathProviderTest {
class ShadowRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, ShadowRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, ShadowRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertThat(actual.getNamedItems().size(), is(3));
assertTrue(actual.getNamedItems().containsKey(ShadowRuleNodeProvider.SHADOW_ALGORITHMS));
assertTrue(actual.getNamedItems().containsKey(ShadowRuleNodeProvider.TABLES));
Expand Down
2 changes: 1 addition & 1 deletion ...n/java/org/apache/shardingsphere/sharding/metadata/nodepath/ShardingRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import java.util.Arrays;

/**
* Sharding rule node path provider.
* Sharding rule node provider.
*/
public final class ShardingRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...ath/ShardingRuleNodePathProviderTest.java → ...odepath/ShardingRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;

class ShardingRuleNodePathProviderTest {
class ShardingRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, ShardingRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, ShardingRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertThat(actual.getNamedItems().size(), is(6));
List<String> namedRuleItems = Arrays.asList(ShardingRuleNodeProvider.TABLES, ShardingRuleNodeProvider.AUTO_TABLES, ShardingRuleNodeProvider.BINDING_TABLES,
ShardingRuleNodeProvider.SHARDING_ALGORITHMS, ShardingRuleNodeProvider.KEY_GENERATORS, ShardingRuleNodeProvider.AUDITORS);
Expand Down
14 changes: 7 additions & 7 deletions ...ative-image/org.apache.shardingsphere/generated-reachability-metadata/reflect-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.broadcast.metadata.nodepath.BroadcastRuleNodePathProvider"
"name":"org.apache.shardingsphere.broadcast.metadata.nodepath.BroadcastRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.infra.route.engine.SQLRouteEngine"},
Expand Down Expand Up @@ -1190,7 +1190,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.encrypt.metadata.nodepath.EncryptRuleNodePathProvider"
"name":"org.apache.shardingsphere.encrypt.metadata.nodepath.EncryptRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
Expand Down Expand Up @@ -2046,7 +2046,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.mask.metadata.nodepath.MaskRuleNodePathProvider"
"name":"org.apache.shardingsphere.mask.metadata.nodepath.MaskRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
Expand Down Expand Up @@ -2478,7 +2478,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.readwritesplitting.metadata.nodepath.ReadwriteSplittingRuleNodePathProvider"
"name":"org.apache.shardingsphere.readwritesplitting.metadata.nodepath.ReadwriteSplittingRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.infra.route.engine.SQLRouteEngine"},
Expand Down Expand Up @@ -2617,7 +2617,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.shadow.metadata.nodepath.ShadowRuleNodePathProvider"
"name":"org.apache.shardingsphere.shadow.metadata.nodepath.ShadowRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.infra.route.engine.SQLRouteEngine"},
Expand Down Expand Up @@ -2909,7 +2909,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.sharding.metadata.nodepath.ShardingRuleNodePathProvider"
"name":"org.apache.shardingsphere.sharding.metadata.nodepath.ShardingRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
Expand Down Expand Up @@ -3184,7 +3184,7 @@
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"name":"org.apache.shardingsphere.single.metadata.nodepath.SingleRuleNodePathProvider"
"name":"org.apache.shardingsphere.single.metadata.nodepath.SingleRuleNodeProvider"
},
{
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
Expand Down
2 changes: 1 addition & 1 deletion ...tive-image/org.apache.shardingsphere/generated-reachability-metadata/resource-config.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,7 +332,7 @@
"pattern":"\\QMETA-INF/services/org.apache.shardingsphere.mode.metadata.refresher.metadata.pushdown.PushDownMetaDataRefresher\\E"
}, {
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.frontend.postgresql.command.query.extended.Portal"},
"pattern":"\\QMETA-INF/services/org.apache.shardingsphere.mode.node.spi.RuleNodePathProvider\\E"
"pattern":"\\QMETA-INF/services/org.apache.shardingsphere.mode.node.spi.RuleNodeProvider\\E"
}, {
"condition":{"typeReachable":"org.apache.shardingsphere.proxy.initializer.BootstrapInitializer"},
"pattern":"\\QMETA-INF/services/org.apache.shardingsphere.mode.persist.service.PersistServiceBuilder\\E"
Expand Down
2 changes: 1 addition & 1 deletion .../main/java/org/apache/shardingsphere/single/metadata/nodepath/SingleRuleNodeProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import java.util.Collections;

/**
* Single rule node path provider.
* Single rule node provider.
*/
public final class SingleRuleNodeProvider implements DatabaseRuleNodeProvider {

Expand Down
6 changes: 3 additions & 3 deletions ...epath/SingleRuleNodePathProviderTest.java → .../nodepath/SingleRuleNodeProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertTrue;

class SingleRuleNodePathProviderTest {
class SingleRuleNodeProviderTest {

private final DatabaseRuleNodeProvider pathProvider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, SingleRuleConfiguration.class);
private final DatabaseRuleNodeProvider provider = TypedSPILoader.getService(DatabaseRuleNodeProvider.class, SingleRuleConfiguration.class);

@Test
void assertGetDatabaseRuleNode() {
DatabaseRuleNode actual = pathProvider.getDatabaseRuleNode();
DatabaseRuleNode actual = provider.getDatabaseRuleNode();
assertTrue(actual.getNamedItems().isEmpty());
assertThat(actual.getUniqueItems().size(), is(2));
assertTrue(actual.getUniqueItems().containsKey(SingleRuleNodeProvider.TABLES));
Expand Down
Loading