chore: migrating java-sdk-common to this repo (#15)

This PR copies existing java-sdk-common code from the private repo and
takes the same approach as the java-server-sdk-otel package for having
it use github actions and release-please for CICD.

I made a separate commit for the code copy to make that easier to
verify. All code in lib/shared/common should be identical to the
[existing repo
](https://github.com/launchdarkly/java-sdk-common-private) with no
changes intended.

Author: tanderson-ld

.github/ISSUE_TEMPLATE/package-sdk-common--bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Feature request for the java-sdk-common package
+about: Suggest an idea for this project
+title: ''
+labels: 'package: java-sdk-common, enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I would love to see the SDK [...does something new...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context about the feature request here.

.github/ISSUE_TEMPLATE/package-sdk-commonl--bug_report.md

@@ -0,0 +1,36 @@
+---
+name: 'Bug report for the java-sdk-common package'
+about: Create a report to help us improve
+title: ''
+labels: 'package: java-sdk-common, bug'
+assignees: ''
+---
+
+**Is this a support request?**
+This issue tracker is maintained by LaunchDarkly SDK developers and is intended for feedback on the code in this library. If you're not sure whether the problem you are having is specifically related to this library, or to the LaunchDarkly service overall, it may be more appropriate to contact the LaunchDarkly support team; they can help to investigate the problem and will consult the SDK team if necessary. You can submit a support request by going [here](https://support.launchdarkly.com/) and clicking "submit a request", or by emailing [email protected].
+
+Note that issues filed on this issue tracker are publicly accessible. Do not provide any private account information on your issues. If your problem is specific to your account, you should submit a support request as described above.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+If applicable, add any log output related to your problem.
+
+**SDK version**
+The version of this SDK that you are using.
+
+**Language version, developer tools**
+For instance, Go 1.11 or Ruby 2.5.3. If you are using a language that requires a separate compiler, such as C, please include the name and version of the compiler too.
+
+**OS/platform**
+For instance, Ubuntu 16.04, Windows 10, or Android 4.0.3. If your code is running in a browser, please also include the browser type and version.
+
+**Additional context**
+Add any other context about the problem here.

.github/workflows/java-sdk-common.yml

@@ -0,0 +1,23 @@
+name: java-sdk-common
+
+on:
+  push:
+    branches: [main, 'feat/**']
+    paths-ignore:
+      - '**.md' #Do not need to run CI for markdown changes.
+  pull_request:
+    branches: [main, 'feat/**']
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  build-test-java-sdk-common:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Shared CI Steps
+        uses: ./.github/actions/ci
+        with:
+          workspace_path: 'lib/shared/common'
+          java_version: 8

.github/workflows/manual-publish-docs.yml

@@ -7,6 +7,7 @@ on:
         type: choice
         options:
           - lib/java-server-sdk-otel
+          - lib/shared/common
       dry_run:
         description: 'Is this a dry run. If so no docs will be published.'
         type: boolean

.github/workflows/manual-publish.yml

@@ -8,6 +8,7 @@ on:
         type: choice
         options:
           - lib/java-server-sdk-otel
+          - lib/shared/common
       prerelease:
         description: 'Is this a prerelease.'
         type: boolean

.github/workflows/release-please.yml

@@ -11,6 +11,7 @@ jobs:
 
     outputs:
       package-server-sdk-otel-released: ${{ steps.release.outputs['lib/java-server-sdk-otel--release_created'] }}
+      package-sdk-common-released: ${{ steps.release.outputs['lib/java-sdk-common--release_created'] }}
 
     steps:
       - uses: google-github-actions/release-please-action@v4
@@ -43,8 +44,42 @@ jobs:
       - uses: ./.github/actions/full-release
         with:
           workspace_path: lib/java-server-sdk-otel
-          dry_run: true #TODO make this false
-          prerelease: true #TODO make this false
+          dry_run: false
+          prerelease: false
+          code_signing_keyring: 'code-signing-keyring.gpg'
+          signing_key_id: ${{ env.SIGNING_KEY_ID }}
+          signing_key_passphrase: ${{ env.SIGNING_KEY_PASSPHRASE }}
+          sonatype_username: ${{ env.SONATYPE_USER_NAME }}
+          sonatype_password: ${{ env.SONATYPE_PASSWORD }}
+          aws_role: ${{ vars.AWS_ROLE_ARN }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  release-sdk-common:
+    runs-on: ubuntu-latest
+    needs: release-please
+    permissions:
+      id-token: write
+      contents: write
+      pull-requests: write
+    if: ${{ needs.release-please.outputs.package-sdk-common-released == 'true'}}
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: launchdarkly/gh-actions/actions/[email protected]
+        name: Get secrets
+        with:
+          aws_assume_role: ${{ vars.AWS_ROLE_ARN }}
+          ssm_parameter_pairs: '/production/common/releasing/sonatype/username = SONATYPE_USER_NAME,
+          /production/common/releasing/sonatype/password = SONATYPE_PASSWORD,
+          /production/common/releasing/android_code_signing/private_key_id = SIGNING_KEY_ID,
+          /production/common/releasing/android_code_signing/private_key_passphrase = SIGNING_KEY_PASSPHRASE'
+          s3_path_pairs: 'launchdarkly-releaser/android/code-signing-keyring.gpg = code-signing-keyring.gpg'
+
+      - uses: ./.github/actions/full-release
+        with:
+          workspace_path: lib/shared/common
+          dry_run: true #TODO make this false after testing
+          prerelease: true #TODO make this false after testing
           code_signing_keyring: 'code-signing-keyring.gpg'
           signing_key_id: ${{ env.SIGNING_KEY_ID }}
           signing_key_passphrase: ${{ env.SIGNING_KEY_PASSPHRASE }}

.release-please-manifest.json

@@ -1,3 +1,4 @@
 {
-  "lib/java-server-sdk-otel": "0.1.0"
+  "lib/java-server-sdk-otel": "0.1.0",
+  "lib/shared/common": "2.1.1"
 }

README.md

@@ -5,14 +5,20 @@ This includes shared libraries, used by SDKs and other tools, as well as SDKs.
 
 ## Packages
 
+| Shared Packages                                                  | API Docs                                                           | maven                                                      | issues                                | tests                                                         |
+| ---------------------------------------------------------------- |--------------------------------------------------------------------| ---------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------- |
+| [@launchdarkly/java-sdk-common](lib/shared/common/README.md)     | [![Documentation][sdk-common-docs-badge]][sdk-common-docs-link]    | [![maven][sdk-common-maven-badge]][sdk-common-maven-link]  | [Issues][sdk-common-issues]           | [![Actions Status][sdk-common-ci-badge]][sdk-common-ci-link]  |
+
 | Telemetry Packages                                                           | API Docs                                                     | maven                                                      | issues                                | tests                                                         |
 | ---------------------------------------------------------------------------- |--------------------------------------------------------------| ---------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------- |
-| [@launchdarkly/java-server-sdk-otel](lib/java-server-sdk-otel/README.md)     | [![Documentation][api-docs-badge]][server-otel-docs-link]    | [![maven][server-otel-maven-badge]][server-otel-maven-link]         | [Issues][java-otel-issues]         | [![Actions Status][server-otel-ci-badge]][server-otel-ci-link]         |
+| [@launchdarkly/java-server-sdk-otel](lib/java-server-sdk-otel/README.md)     | [![Documentation][server-otel-docs-badge]][server-otel-docs-link]    | [![maven][server-otel-maven-badge]][server-otel-maven-link]         | [Issues][server-otel-issues]         | [![Actions Status][server-otel-ci-badge]][server-otel-ci-link]         |
 
 ## Organization
 
 `lib` Top level directory containing package implementations.
 
+`lib/shared` Packages which are primarily intended for consumption by LaunchDarkly and are used in other packages types.
+
 ## LaunchDarkly overview
 
 [LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
@@ -43,11 +49,19 @@ We encourage pull requests and other contributions from the community. Check out
   - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
 
 [//]: # 'java-server-sdk-otel'
-[java-otel-issues]: https://github.com/launchdarkly/java-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+java-server-sdk-otel%22+
+[server-otel-issues]: https://github.com/launchdarkly/java-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+java-server-sdk-otel%22+
 [server-otel-maven-badge]: https://img.shields.io/maven-central/v/com.launchdarkly/launchdarkly-java-server-sdk-otel
 [server-otel-maven-link]: https://central.sonatype.com/artifact/com.launchdarkly/launchdarkly-java-server-sdk-otel
 [server-otel-ci-badge]: https://github.com/launchdarkly/java-core/actions/workflows/java-server-sdk-otel.yml/badge.svg
 [server-otel-ci-link]: https://github.com/launchdarkly/java-core/actions/workflows/java-server-sdk-otel.yml
+[server-otel-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
 [server-otel-docs-link]: https://launchdarkly.github.io/java-core/lib/java-server-sdk-otel/
 
-[api-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
+[//]: # 'java-sdk-common'
+[sdk-common-issues]: https://github.com/launchdarkly/java-core/issues?q=is%3Aissue+is%3Aopen+label%3A%22package%3A+java-sdk-common%22+
+[sdk-common-maven-badge]: https://img.shields.io/maven-central/v/com.launchdarkly/launchdarkly-java-sdk-common
+[sdk-common-maven-link]: https://central.sonatype.com/artifact/com.launchdarkly/launchdarkly-java-sdk-common
+[sdk-common-ci-badge]: https://github.com/launchdarkly/java-core/actions/workflows/java-sdk-common.yml/badge.svg
+[sdk-common-ci-link]: https://github.com/launchdarkly/java-core/actions/workflows/java-sdk-common.yml
+[sdk-common-docs-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
+[sdk-common-docs-link]: https://launchdarkly.github.io/java-core/lib/shared/common/

lib/shared/common/.circleci/config.yml

@@ -0,0 +1,162 @@
+version: 2.1
+
+orbs:
+   win: circleci/[email protected]
+   android: circleci/[email protected]
+
+workflows:
+  test:
+    jobs:
+      - build-linux
+      - test-linux:
+          name: Java 8 - Linux - OpenJDK
+          docker-image: cimg/openjdk:8.0
+          requires:
+            - build-linux
+      - test-linux:
+          name: Java 11 - Linux - OpenJDK
+          docker-image: cimg/openjdk:11.0
+          requires:
+            - build-linux
+      - test-linux:
+          # current LTS version
+          name: Java 17 - Linux - OpenJDK
+          docker-image: cimg/openjdk:17.0
+          with-coverage: true
+          requires:
+            - build-linux
+      - test-linux:
+          name: Java 19 - Linux - OpenJDK
+          docker-image: cimg/openjdk:19.0
+          requires:
+            - build-linux
+# Windows Java 11 build is temporarily disabled - see story 171428
+#      - test-windows:
+#          name: Java 11 - Windows - OpenJDK
+#          openjdk-version: 11.0.2.01
+      - build-test-windows:
+          name: Java 17 - Windows - OpenJDK
+          openjdk-version: 17.0.1
+      - build-test-android:
+          name: Android
+
+jobs:
+  build-linux:
+    docker:
+      - image: cimg/openjdk:8.0
+    steps:
+      - checkout
+      - run: cp gradle.properties.example gradle.properties
+      - run: java -version
+      - run: ./gradlew dependencies
+      - run: ./gradlew jar
+      - run: ./gradlew javadoc
+      - run: ./gradlew checkstyleMain
+      - persist_to_workspace:
+          root: build
+          paths:
+            - classes
+
+  test-linux:
+    parameters:
+      docker-image:
+        type: string
+      with-coverage:
+        type: boolean
+        default: false
+    docker:
+      - image: <<parameters.docker-image>>
+    steps:
+      - checkout
+      - run: cp gradle.properties.example gradle.properties
+      - attach_workspace:
+          at: build
+      - run: java -version
+      - run: ./gradlew test
+      - when:
+          condition: <<parameters.with-coverage>>
+          steps:
+            - run:
+                name: Generate test coverage report
+                command: |
+                  ./gradlew jacocoTestReport
+                  mkdir -p coverage/
+                  cp -r build/reports/jacoco/test/* ./coverage
+            - run:
+                name: Enforce test coverage
+                command: ./gradlew jacocoTestCoverageVerification
+      - run:
+          name: Save test results
+          command: |
+            mkdir -p ~/junit/;
+            find . -type f -regex ".*/build/test-results/.*xml" -exec cp {} ~/junit/ \;
+          when: always
+      - store_test_results:
+          path: ~/junit
+      - store_artifacts:
+          path: ~/junit
+      - when:
+          condition: <<parameters.with-coverage>>
+          steps:
+            - store_artifacts:
+                path: coverage
+
+  build-test-windows:
+    parameters:
+      openjdk-version:
+        type: string
+    executor:
+      name: win/vs2019
+      shell: powershell.exe
+    steps:
+      - checkout
+      - run:
+          name: uninstall previous openjdk
+          command: choco uninstall openjdk
+      - run:
+          name: install OpenJDK
+          command: choco install openjdk --version <<parameters.openjdk-version>>
+      - run:
+          name: build and test
+          command: |
+            cp gradle.properties.example gradle.properties
+            .\gradlew.bat --no-daemon test  # must use --no-daemon because CircleCI in Windows will hang if there's a daemon running
+      - run:
+          name: save test results
+          command: |
+            mkdir .\junit
+            cp build/test-results/test/*.xml junit
+      - store_test_results:
+          path: .\junit
+      - store_artifacts:
+          path: .\junit
+
+  build-test-android:
+    executor:
+      name: android/android-machine
+      resource-class: large
+
+    steps:
+      - checkout
+
+      # What we want to do here is somewhat unusual: we want Android to run all of our tests from
+      # src/test/java, but run them in the Android emulator (to prove that we're only using Java
+      # APIs that our minimum Android API version supports). Normally, only tests in
+      # src/androidTest/java would be run that way. Also, Android needs a different JUnit test
+      # runner annotation on all of the test classes. So we can't just run the test code as-is.
+      #
+      # This step copies all the code from src/test/java into src/androidTest/java, except for the
+      # base class BaseTest.java, which is already defined in src/androidTest/java to provide the
+      # necessary test runner annotation.
+      - run:
+          name: Copy tests
+          command: rsync -r ./src/test/java/ ./src/androidTest/java/ --exclude='BaseTest.java'
+
+      - android/start-emulator-and-run-tests:
+          system-image: system-images;android-21;default;x86
+          max-tries: 1
+          post-emulator-launch-assemble-command: ./gradlew -b build-android.gradle :assembleAndroidTest
+          test-command: ./gradlew -b build-android.gradle :connectedAndroidTest
+
+      - store_test_results:
+          path: ./build/outputs/androidTest-results

lib/shared/common/.gitignore

@@ -0,0 +1,22 @@
+# Eclipse project files
+.classpath
+.project
+.settings
+
+# Intellij project files
+*.iml
+*.ipr
+*.iws
+.idea/
+ 
+#Gradle
+.gradletasknamecache
+.gradle/
+build/
+bin/
+out/
+classes/
+
+# Test code that gets temporarily copied by our Android CI build
+src/androidTest/java/com/launchdarkly/sdk/**/*.java
+!src/androidTest/java/com/launchdarkly/sdk/BaseTest.java