Updated all javadoc for publishing to maven central

Author: wolpert

database-test/src/test/java/com/codeheadsystems/test/datastore/DynamoDbExtensionTest.java

@@ -28,40 +28,67 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+/**
+ * The type Dynamo db extension test.
+ */
 @ExtendWith(DynamoDbExtension.class)
 class DynamoDbExtensionTest {
 
+  /**
+   * The constant ATTRIBUTE.
+   */
   public static final String ATTRIBUTE = "aAttribute";
+  /**
+   * The constant RANGE.
+   */
   public static final String RANGE = "aRange";
+  /**
+   * The constant HASH.
+   */
   public static final String HASH = "aHash";
   @DataStore private DynamoDBMapper mapper;
   @DataStore private AmazonDynamoDB amazonDynamoDb;
 
+  /**
+   * Sets .
+   */
   @BeforeEach
   void setup() {
     amazonDynamoDb.createTable(
         mapper.generateCreateTableRequest(Entry.class)
             .withBillingMode(BillingMode.PAY_PER_REQUEST));
   }
 
+  /**
+   * Tear down.
+   */
   @AfterEach
   void tearDown() {
     // force the table empty
     amazonDynamoDb.deleteTable(mapper.generateDeleteTableRequest(Entry.class));
   }
 
+  /**
+   * Test client.
+   */
   @Test
   void testClient() {
     assertThat(amazonDynamoDb)
         .isNotNull();
   }
 
+  /**
+   * Test mapper.
+   */
   @Test
   void testMapper() {
     assertThat(mapper)
         .isNotNull();
   }
 
+  /**
+   * Table exists and is empty.
+   */
   @Test
   void tableExistsAndIsEmpty() {
     final DynamoDBScanExpression expression = new DynamoDBScanExpression();
@@ -71,6 +98,9 @@ void tableExistsAndIsEmpty() {
         .isEmpty();
   }
 
+  /**
+   * We can add items.
+   */
   @Test
   void weCanAddItems() {
     final Entry entry = new Entry(HASH, RANGE, ATTRIBUTE);

feature-flag-ddb-test/src/test/java/org/codeheadsystems/featureflag/manager/impl/DdbFeatureLookupManagerIntegTest.java

@@ -7,13 +7,19 @@
 import org.junit.jupiter.api.extension.ExtendWith;
 import software.amazon.awssdk.services.dynamodb.DynamoDbClient;
 
+/**
+ * The type Ddb feature lookup manager integ test.
+ */
 @ExtendWith(DynamoDbExtension.class)
 class DdbFeatureLookupManagerIntegTest extends FeatureLookupManagerIntegTest {
 
   private static final DynamoDbConfiguration DB_CONFIGURATION = ImmutableDynamoDbConfiguration.builder().build();
 
   @DataStore private DynamoDbClient dbClient;
 
+  /**
+   * Sets database.
+   */
   @BeforeEach
   void setupDatabase() {
     final DdbControlPlane ddbControlPlane = new DdbControlPlane(DB_CONFIGURATION, dbClient);

feature-flag-etcd/src/test/java/org/codeheadsystems/featureflag/manager/impl/EtcdEnablementLookupManagerIntegTest.java

@@ -11,17 +11,26 @@
  * A longer test that starts up an etcd process. But not really that long.
  */
 public class EtcdEnablementLookupManagerIntegTest extends FeatureLookupManagerIntegTest {
+  /**
+   * The constant cluster.
+   */
   @RegisterExtension
   public static final EtcdClusterExtension cluster = EtcdClusterExtension.builder()
       .withNodes(1)
       .build();
   private Client client;
 
+  /**
+   * Sets client.
+   */
   @BeforeEach
   void setupClient() {
     client = Client.builder().endpoints(cluster.clientEndpoints()).build();
   }
 
+  /**
+   * Tear down client.
+   */
   @AfterEach
   void tearDownClient() {
     client.close();

feature-flag-etcd/src/test/java/org/codeheadsystems/featureflag/manager/impl/EtcdEnablementLookupManagerTest.java

@@ -30,6 +30,9 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+/**
+ * The type Etcd enablement lookup manager test.
+ */
 @ExtendWith(MockitoExtension.class)
 class EtcdEnablementLookupManagerTest {
 
@@ -56,11 +59,21 @@ private static ByteSequence getNamespaceKeyBytes() {
   }
 
 
+  /**
+   * Sets up.
+   */
   @BeforeEach
   void setUp() {
     etcdFeatureLookupManager = new EtcdFeatureLookupManager(client, PREAMBLE);
   }
 
+  /**
+   * Lookup percentage found.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   * @throws TimeoutException     the timeout exception
+   */
   @Test
   void lookupPercentage_found() throws ExecutionException, InterruptedException, TimeoutException {
     when(client.getKVClient()).thenReturn(kv);
@@ -74,6 +87,13 @@ void lookupPercentage_found() throws ExecutionException, InterruptedException, T
         .contains(0.5);
   }
 
+  /**
+   * Lookup percentage not found.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   * @throws TimeoutException     the timeout exception
+   */
   @Test
   void lookupPercentage_notFound() throws ExecutionException, InterruptedException, TimeoutException {
     when(client.getKVClient()).thenReturn(kv);
@@ -85,6 +105,13 @@ void lookupPercentage_notFound() throws ExecutionException, InterruptedException
         .isEmpty();
   }
 
+  /**
+   * Lookup percentage interrupted.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   * @throws TimeoutException     the timeout exception
+   */
   @Test
   void lookupPercentage_interrupted() throws ExecutionException, InterruptedException, TimeoutException {
     when(client.getKVClient()).thenReturn(kv);
@@ -94,6 +121,13 @@ void lookupPercentage_interrupted() throws ExecutionException, InterruptedExcept
         .isThrownBy(() -> etcdFeatureLookupManager.lookupPercentage(FEATURE_ID));
   }
 
+  /**
+   * Lookup percentage execution exception.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   * @throws TimeoutException     the timeout exception
+   */
   @Test
   void lookupPercentage_executionException() throws ExecutionException, InterruptedException, TimeoutException {
     when(client.getKVClient()).thenReturn(kv);
@@ -103,6 +137,12 @@ void lookupPercentage_executionException() throws ExecutionException, Interrupte
         .isThrownBy(() -> etcdFeatureLookupManager.lookupPercentage(FEATURE_ID));
   }
 
+  /**
+   * Sets percentage.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   void setPercentage() throws ExecutionException, InterruptedException {
     when(client.getKVClient()).thenReturn(kv);
@@ -114,6 +154,12 @@ void setPercentage() throws ExecutionException, InterruptedException {
     verify(putResponseCompletableFuture).get();
   }
 
+  /**
+   * Sets percentage interrupted.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   void setPercentage_interrupted() throws ExecutionException, InterruptedException {
     when(client.getKVClient()).thenReturn(kv);
@@ -123,6 +169,12 @@ void setPercentage_interrupted() throws ExecutionException, InterruptedException
         .isThrownBy(() -> etcdFeatureLookupManager.setPercentage(FEATURE_ID, 0.5));
   }
 
+  /**
+   * Sets percentage execution exception.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   void setPercentage_executionException() throws ExecutionException, InterruptedException {
     when(client.getKVClient()).thenReturn(kv);
@@ -132,6 +184,12 @@ void setPercentage_executionException() throws ExecutionException, InterruptedEx
         .isThrownBy(() -> etcdFeatureLookupManager.setPercentage(FEATURE_ID, 0.5));
   }
 
+  /**
+   * Delete percentage.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   void deletePercentage() throws ExecutionException, InterruptedException {
     when(client.getKVClient()).thenReturn(kv);
@@ -142,6 +200,12 @@ void deletePercentage() throws ExecutionException, InterruptedException {
     assertThat(values).containsExactly(PREAMBLE + "_" + NAMESPACE + "/" + FEATURE_ID);
   }
 
+  /**
+   * Delete percentage interrupted.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   void deletePercentage_interrupted() throws ExecutionException, InterruptedException {
     when(client.getKVClient()).thenReturn(kv);
@@ -151,6 +215,12 @@ void deletePercentage_interrupted() throws ExecutionException, InterruptedExcept
         .isThrownBy(() -> etcdFeatureLookupManager.deletePercentage(FEATURE_ID));
   }
 
+  /**
+   * Delete percentage execution exception.
+   *
+   * @throws ExecutionException   the execution exception
+   * @throws InterruptedException the interrupted exception
+   */
   @Test
   void deletePercentage_executionException() throws ExecutionException, InterruptedException {
     when(client.getKVClient()).thenReturn(kv);

feature-flag-integ/src/test/java/org/codeheadsystems/featureflag/manager/FullSqlTest.java

@@ -76,6 +76,9 @@ void setupSql(Metrics metrics, Jdbi jdbi) {
         .build();
   }
 
+  /**
+   * Temporary test.
+   */
   @Test
   void temporaryTest() {
     // This is a temporary test

feature-flag-metrics/src/test/java/org/codeheadsystems/featureflag/manager/MetricsDecoratorTest.java

@@ -9,13 +9,19 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+/**
+ * The type Metrics decorator test.
+ */
 @ExtendWith(MockitoExtension.class)
 class MetricsDecoratorTest {
 
   @Mock private Metrics metrics;
 
   @InjectMocks private MetricsDecorator metricsDecorator;
 
+  /**
+   * Test decorate.
+   */
   @Test
   public void testDecorate() {
     FeatureManager.Builder builder = new FeatureManager.Builder();

feature-flag/src/test/java/org/codeheadsystems/featureflag/factory/EnablementFactoryTest.java

@@ -16,6 +16,9 @@
 import org.mockito.Mock;
 import org.mockito.junit.jupiter.MockitoExtension;
 
+/**
+ * The type Enablement factory test.
+ */
 @ExtendWith(MockitoExtension.class)
 class EnablementFactoryTest {
 
@@ -60,6 +63,13 @@ private static Stream<Arguments> provideGenerate() {
     );
   }
 
+  /**
+   * Generate.
+   *
+   * @param featurePercentage the feature percentage
+   * @param hashCodeInt       the hash code int
+   * @param expected          the expected
+   */
   @ParameterizedTest
   @MethodSource("provideGenerate")
   void generate(final double featurePercentage, final int hashCodeInt, final boolean expected) {
@@ -70,16 +80,29 @@ void generate(final double featurePercentage, final int hashCodeInt, final boole
         .isEqualTo(expected);
   }
 
+  /**
+   * Enabled feature.
+   */
   @Test
   void enabledFeature() {
     assertThat(enablementFactory.enabledFeature().enabled(TEST)).isTrue();
   }
 
+  /**
+   * Disabled feature.
+   */
   @Test
   void disabledFeature() {
     assertThat(enablementFactory.disabledFeature().enabled(TEST)).isFalse();
   }
 
+  /**
+   * Percentage feature.
+   *
+   * @param featurePercentage the feature percentage
+   * @param hashCodeInt       the hash code int
+   * @param expected          the expected
+   */
   @ParameterizedTest
   @MethodSource("provideGenerate")
   void percentageFeature(final double featurePercentage, final int hashCodeInt, final boolean expected) {