Merge pull request #1 from kbase/dev-add_code

Add test code from java_common

.gitattributes

@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+

.github/codeql.yml

@@ -0,0 +1,62 @@
+name: "Code scanning - action"
+
+on:
+  pull_request:
+    types:
+    - opened
+    - reopened
+    - synchronize
+    - ready_for_review
+  push:
+    # run workflow when merging to main/master or develop
+    branches:
+      - main
+      - master
+      - develop
+  schedule:
+    - cron: '0 19 * * 0'
+
+jobs:
+  CodeQL-Build:
+
+    # CodeQL runs on ubuntu-latest and windows-latest
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/dependabot.yml

@@ -0,0 +1,17 @@
+version: 2
+updates:
+
+  # Docker
+  - package-ecosystem: docker
+    directory: "/"
+    schedule:
+      interval: weekly
+      time: '11:00'
+    open-pull-requests-limit: 25
+
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: ".github/workflows"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 25

.github/workflows/test.yml

@@ -0,0 +1,44 @@
+name: KBase Java Test utilities tests
+
+on:
+  pull_request:
+    types:
+    - opened
+    - reopened
+    - synchronize
+    - ready_for_review
+  push:
+    # run workflow when merging to main / master / develop
+    branches:
+      - main
+      - develop
+
+jobs:
+
+  java_test_utilities_tests:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - java: '8'
+          - java: '11'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup java
+        uses: actions/setup-java@v4
+        with:
+          distribution: 'temurin'
+          java-version: ${{matrix.java}}
+
+      - name: Run tests
+        run: |
+           ./gradlew test
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true

LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2014-present The KBase Project and its Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1 +1,51 @@
 # Java Test Utilities
+
+Contains code for use in tests, including exception checkers, methods to add data to
+[Auth2](https://github.com/kbase/auth2) testmode, and controllers for 3rd party data stores.
+
+## Including the library in your build
+
+See https://jitpack.io/#kbase/java_test_utilities/ for instructions on how to include JitPack built
+dependencies in your build.
+
+## JavaDoc
+
+JavaDoc is available at
+```
+https://javadoc.jitpack.io/com/github/kbase/java_test_utilities/<version>/javadoc/
+```
+
+For example:
+
+https://javadoc.jitpack.io/com/github/kbase/java_test_utilities/0.1.0/javadoc/
+
+## Adding and releasing code
+
+* Adding code
+  * All code additions and updates must be made as pull requests directed at the develop branch.
+    * All tests must pass and all new code must be covered by tests.
+    * All new code must be documented appropriately
+      * Javadoc
+      * General documentation if appropriate
+      * Release notes
+* Releases
+  * The main branch is the stable branch. Releases are made from the develop branch to the main
+    branch.
+  * Tag the version in git and github.
+  * Create a github release.
+  * Check that the javadoc is appropriately built on JitPack.
+
+## Testing
+
+```
+./gradlew test
+```
+
+## TODO
+
+* Add tests
+* Javadoc
+
+## Original home
+
+https://github.com/kbase/java_common

RELEASE_NOTES.md

@@ -0,0 +1,5 @@
+# Release notes
+
+## 0.1.0
+
+* Initial release.

build.gradle

@@ -0,0 +1,72 @@
+/*
+ * This file was generated by the Gradle 'init' task.
+ */
+
+plugins {
+	id 'java'
+	id 'jacoco'
+	id 'maven-publish'
+}
+
+group = 'com.github.kbase'
+
+repositories {
+	mavenCentral()
+}
+
+compileJava {
+	// TODO BUILD remove when we no longer support java 8, use `options.release = 11` if needed
+	java.sourceCompatibility = JavaVersion.VERSION_1_8
+	java.targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+java {
+	withSourcesJar()
+	withJavadocJar()
+}
+
+test {
+	testLogging {
+		exceptionFormat = 'full'
+		showStandardStreams = true
+	}
+	finalizedBy jacocoTestReport
+}
+
+jacocoTestReport {
+	reports {
+		xml.required = true
+		csv.required = true
+	}
+}
+
+javadoc {
+	failOnError = false  // hamcrest 1.1. causes this to fail
+	options {
+		// I don't know why this isn't working, but it's not worth spending time on right now
+		links "https://docs.oracle.com/javase/8/docs/api/"
+	}
+}
+
+publishing {
+	publications {
+		maven(MavenPublication) {
+			from components.java
+		}
+	}
+}
+
+dependencies {
+
+	// using older dependencies to not force upgrades on repos that might not be able to
+	// handle them. Need to upgrade the services and then upgrade here
+	implementation 'junit:junit:4.9'
+	implementation 'org.slf4j:slf4j-api:1.7.7'
+	implementation 'ch.qos.logback:logback-classic:1.1.2'
+	implementation 'commons-io:commons-io:2.4'
+	implementation "com.fasterxml.jackson.core:jackson-databind:2.9.9"
+	implementation 'org.apache.commons:commons-lang3:3.1'
+	implementation 'com.google.guava:guava:18.0'
+	implementation 'org.ini4j:ini4j:0.5.2'
+	implementation 'com.github.zafarkhaja:java-semver:0.9.0'
+}

gradle/libs.versions.toml

@@ -0,0 +1,2 @@
+# This file was generated by the Gradle 'init' task.
+# https://docs.gradle.org/current/userguide/platforms.html#sub::toml-dependencies-format

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.7-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists