Hibernate 5.4 extension updates

.github/workflows/main.yml

@@ -3,60 +3,157 @@
 
 name: Java CI
 
-on: [push, pull_request,workflow_dispatch]
+on: [push, pull_request, workflow_dispatch]
 
 jobs:
   build:
 
     runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '__CI__')"
     env:
-      luceeVersion: light-6.0.0.316-SNAPSHOT
+      luceeVersion: 6.0.0.316-SNAPSHOT
 
     steps:
     - uses: actions/checkout@v3
+
     - name: Set up JDK 11
       uses: actions/setup-java@v3
       with:
         java-version: '11'
-        distribution: 'adopt'
+        distribution: 'temurin'
+
     - name: Cache Maven packages
       uses: actions/cache@v3
       with:
         path: ~/.m2
         key: lucee-script-runner-maven-cache
+
     - name: Cache Lucee files
       uses: actions/cache@v3
       with:
         path: _actions/lucee/script-runner/main/lucee-download-cache
         key: lucee-downloads-${{ env.luceeVersion }}
         restore-keys: |
           lucee-downloads
+
     - name: Build with Ant
       run: ant -noinput -verbose -buildfile build.xml
+
     - name: Upload Artifact
       uses: actions/upload-artifact@v3
       with:
         name: hibernate-lex
         path: dist/*.lex
+
     - name: Checkout Lucee
       uses: actions/checkout@v3
       with:
         repository: lucee/lucee
         path: lucee
-    - name: Run Lucee Test Suite (testFilter="orm")
+
+    - name: Run Lucee Test Suite (testLabels="orm")
       uses: lucee/script-runner@main
       with:
         webroot: ${{ github.workspace }}/lucee/test
         execute: /bootstrap-tests.cfm
-        luceeVersion: ${{ env.luceeVersion }}
+        luceeVersion: light-${{ env.luceeVersion }}
         extensionDir: ${{ github.workspace }}/dist
       env:
         testLabels: orm
         testAdditional: ${{ github.workspace }}/tests
+
     - name: Publish Test Results
       uses: EnricoMi/publish-unit-test-result-action@v1
       if: always()
       with:
-        files: ${{ github.workspace }}/lucee/test/reports/junit-test-results.xml
+        files: ${{ github.workspace }}/lucee/test/reports/junit-test-results-${{env.luceeVersion}}.xml
         check_name: "Test Results"
 
+  maven_build:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '__CI__')"
+    strategy:
+      fail-fast: false
+      matrix:
+        lucee_version: ["5.3.10.97"]
+        java_version: [ "8", "11", "17" ]
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          java-version: '${{matrix.java_version}}'
+          distribution: 'temurin'
+
+      - name: Build with Maven
+        run: mvn --batch-mode -f pom.xml -Dlucee.version=${{matrix.lucee_version}} -Djdk.version=${{matrix.java_version}} compile
+
+  javadocs:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '__CI__')"
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 8
+        uses: actions/setup-java@v3
+        with:
+          java-version: '8'
+          distribution: 'temurin'
+
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: maven-cache
+
+      - name: Generate Javadocs
+        run: mvn --batch-mode -f pom.xml javadoc:javadoc
+
+      - name: Get Project Version for Javadocs Versioning
+        id: current_version
+        # For Maven builds (future)
+        # run: echo "VERSION=`mvn help:evaluate -Dexpression=project.version -q -DforceStdout`" >> $GITHUB_ENV
+        # For Ant builds (still the default)
+        run: echo "VERSION=`ant -silent -quiet version`" >> $GITHUB_ENV
+
+      - name: Upload API Docs to S3
+        uses: jakejarvis/s3-sync-action@master
+        with:
+          args: --acl public-read
+        env:
+          AWS_S3_BUCKET: ${{ secrets.AWS_APIDOCS_BUCKET }}
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_ACCESS_SECRET }}
+          SOURCE_DIR: "docs"
+          DEST_DIR: "lucee/hibernate-extension/${{ env.VERSION }}/"
+
+  format:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '__CI__')"
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          token: ${{secrets.GH_TOKEN}}
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+
+      - name: Cache Maven packages
+        uses: actions/cache@v3
+        with:
+          path: ~/.m2
+          key: maven-cache
+
+      - name: Format Java source code
+        run: mvn --batch-mode -f pom.xml formatter:format
+
+      - name: Commit formatting changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          file_pattern: "docs"
+          commit_message: "🤖 CI: Auto-format Java source __CI__"

.gitignore

@@ -1,12 +1,24 @@
-/dist
-temp
-**/.DS_Store
+# Editor and OS artifacts
+.vscode
+.DS_Store
 **/.svn/
 /*.project
 va specific
+
+# build files/dist
+/bin
+/build
+/dist
+/temp
 *.class
-target
-target/*
+/target
 *.lock
 *.DS_Store
-/cache
+/cache
+/docs
+
+# Test artifacts
+WEB-INF/
+
+# Lucee source for CFML tests
+/lucee

README.md

@@ -0,0 +1,78 @@
+# Lucee Hibernate Extension (ORM)
+
+[![Java CI](https://github.com/lucee/extension-hibernate/actions/workflows/main.yml/badge.svg?branch=5.4)](https://github.com/lucee/extension-hibernate/actions/workflows/main.yml) 5.4
+
+[![Java CI](https://github.com/lucee/extension-hibernate/actions/workflows/main.yml/badge.svg?branch=3.5.5)](https://github.com/lucee/extension-hibernate/actions/workflows/main.yml) 3.5.5
+
+[![Java CI](https://github.com/lucee/extension-hibernate/actions/workflows/main.yml/badge.svg)](https://github.com/lucee/extension-hibernate/actions/workflows/main.yml) Master
+
+* A [Hibernate ORM](https://hibernate.org/orm/) wrapper for the [Lucee CFML language](https://www.lucee.org/)
+
+* Issues: https://luceeserver.atlassian.net/issues/?jql=labels%20%3D%20%22orm%22
+* Documentation: https://docs.lucee.org/categories/orm.html
+
+## Contributing
+
+You will need to install the following for extension development:
+
+* Java 1.8+ (JRE and JDK)
+* [ant](https://www.osradar.com/install-apache-ant-ubuntu-20-04/) (for building the extension `.lex` file)
+* [maven](https://linuxize.com/post/how-to-install-apache-maven-on-ubuntu-20-04/) (for other automated tooling)
+* [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/) (for managing test database servers)
+
+### Getting Started
+
+1. Install the repo - `git clone [email protected]:lucee/extension-hibernate.git`
+2. Make changes..
+3. [Build extension via `ant dist`](#building)
+4. Test via `./test.sh` (See [#Testing](#testing) for more info)
+
+**Before you send a PR:**
+
+1. Don't forget to run tests!
+   1. (if you can't get tests to pass, ask for help!)
+2. Format java source code: `mvn formatter:format`
+
+## Building
+
+Using ant builds (for now):
+
+* `ant clean` - clean build directories
+* `ant compile` - compile code
+* `ant dist` - Package the extension into a Lucee-installable `.lex` extension file
+
+Using the Maven builds:
+
+* `mvn test` run java-based (junit) tests
+* `mvn javadoc:javadoc` generate java docs
+* `mvn formatter:format` [format java source](https://code.revelc.net/formatter-maven-plugin/usage.html)
+* `mvn verify` Run OWASP dependency checker to look for vulnerabilities
+
+## Testing
+
+See Lucee documentation on [testing-a-lucee-extension-locally](https://docs.lucee.org/guides/working-with-source/building-and-testing-extensions.html#testing-a-lucee-extension-locally).
+
+To run CFML tests against the extension:
+
+1. Check out [lucee/Lucee](https://github.com/lucee/lucee) to the parent directory - `git clone [email protected]:lucee/Lucee.git ../lucee`
+2. Check out [lucee/script-runner](https://github.com/lucee/script-runner) to the parent directory - `git clone [email protected]:lucee/Lucee.git ../script-runner`.
+
+Next, start the test databases using the Docker-compose setup:
+
+```bash
+cd tests && docker-compose up
+```
+
+This will start Postgres, MySQL, and MSSQL containers using the credentials specified in `tests/.env`.
+
+Finally, you can run tests from the extension root:
+
+```bash
+./test.sh
+```
+
+To build a .lex and test it immediately, chain `ant dist` and `./test.sh`:
+
+```bash
+ant dist && ./test.sh
+```

build.xml

@@ -13,7 +13,10 @@
   <property name="dist"  location="dist"/>
   <property name="src" location="source/java/src"/>
   <property name="srcImg" location="source/images"/>
-
+  <property name="docs.dir"  location="docs/"/>
+  <property name="tld" location="source/tld"/>
+  <property name="fld" location="source/fld"/>
+
   <buildnumber file="build.number"/>
 
 
@@ -38,6 +41,10 @@
     <mkdir dir="${dist}/extension/jars"/>
   </target>
 
+  <!-- Output the project version for use in versioning S3 artifact uploads -->
+  <target name="version">
+    <echo>${bundleversion}${build.number}${versionAppendix}</echo>
+  </target>
 
   <target name="copy" depends="init" description="copy source file to temp" >
     <!-- copy the source -->
@@ -78,10 +85,19 @@ lucee-core-version: "${luceeCoreVersion}"
       <classpath refid="classpath" />
     </javac>
   </target>
+
+  <!-- Generate javadocs for current project into ${doc.dir} -->
+  <target name="doc" depends="init" description="generate documentation">
+    <javadoc sourcepath="${src}" destdir="${docs.dir}"/>
+  </target>
 
   <target name="dist" depends="compile"
         description="generate the distribution" >
-
+
+    <!-- copy the flds used for informing Lucee of the CFML built-in methods -->
+    <copy file="${fld}/ormFunctions.fld" tofile="${dist}/extension/flds/ormFunctions.fld" />
+    <replace file="${dist}/extension/flds/ormFunctions.fld" token="{bundle-name}" value="${bundlename}" />
+    <replace file="${dist}/extension/flds/ormFunctions.fld" token="{bundle-version}" value="${bundleversion}${build.number}${versionAppendix}" />
 
     <!-- Put everything in ${build} into .jar file -->
     <jar