PDAL 2.5.1 (#65)

* PDAL 2.5.x upd

* Refactor JavaPipeline

* Improve tests

* javah re-reun

* Make core more java compatible

* CHANGELOG.md rotate

Author: pomadchin

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        image: ['daunnc/pdal-ubuntu:2.4.3']
+        image: ['daunnc/pdal-ubuntu:2.5.1']
     runs-on: ${{ matrix.os }}
     container:
       image: ${{ matrix.image }}
@@ -43,7 +43,7 @@ jobs:
         os: [macos-latest]
         java: [8]
         distribution: [temurin]
-        pdal: [2.4.3]
+        pdal: [2.5.0]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -69,9 +69,7 @@ jobs:
           brew extract --version=${{ matrix.pdal }} pdal $USER/local-pdal
 
       - name: Install PDAL
-        run: |
-          brew update
-          brew install pdal@${{ matrix.pdal }} || true
+        run: brew install pdal@${{ matrix.pdal }} || true
 
       - name: Check formatting
         run: sbt scalafmtCheckAll
@@ -88,7 +86,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        image: ['daunnc/pdal-ubuntu:2.4.3']
+        image: ['daunnc/pdal-ubuntu:2.5.1']
     runs-on: ${{ matrix.os }}
     needs: [linux, macos]
     container:

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## Added
+* PDAL 2.5.1 [#65](https://github.com/pdal/java/pull/65) (@pomadchin)
 
 ## [2.4.0] - 2021-08-01
 ## Added

build.sbt

@@ -2,7 +2,7 @@ name := "pdal-jni"
 
 val scala212 = "2.12.17"
 val scala213 = "2.13.10"
-val scala3   = "3.2.1"
+val scala3 = "3.2.2"
 val scalaVersions = Seq(scala3, scala213, scala212)
 
 lazy val commonSettings = Seq(
@@ -71,7 +71,10 @@ lazy val core = project
   .settings(name := "pdal")
   .settings(javah / target := (native / nativeCompile / sourceDirectory).value / "include")
   .settings(sbtJniCoreScope := Compile)
-  .settings(libraryDependencies += Dependencies.scalaTest % Test)
+  .settings(libraryDependencies ++= Seq(
+    Dependencies.scalaTest % Test,
+    Dependencies.circe("parser") % Test
+  ))
   .dependsOn(Environment.dependOnNative(native % Runtime): _*)
 
 lazy val native = project

core/src/main/scala/io/pdal/LogLevel.scala

@@ -0,0 +1,38 @@
+/**
+ * **************************************************************************** Copyright (c) 2016, hobu Inc.
+ * ([email protected])
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+ * following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+ * disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
+ * the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the
+ * name of Hobu, Inc. nor the names of its contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+package io.pdal
+
+object LogLevel {
+  val Error = 0
+  val Warning = 1
+  val Info = 2
+  val Debug = 3
+  val Debug1 = 4
+  val Debug2 = 5
+  val Debug3 = 6
+  val Debug4 = 7
+  val Debug5 = 8
+  val None = 9
+}

core/src/main/scala/io/pdal/Pipeline.scala

@@ -26,13 +26,15 @@ package io.pdal
 
 import com.github.sbt.jni.syntax.NativeLoader
 
-class Pipeline(val json: String) extends Native {
+class Pipeline(val json: String, val logLevel: Int) extends Native {
   Pipeline // reference the object so that the nativeLoader will load the JNI native libraries
 
   @native def initialize(): Unit
   @native def execute(): Unit
   @native def getPointViews(): PointViewIterator
   @native def close(): Unit
+  @native def getSrsWKT2(): String
+  @native def getPipeline(): String
   @native def getMetadata(): String
   @native def getSchema(): String
   @native def validate(): Boolean
@@ -41,6 +43,8 @@ class Pipeline(val json: String) extends Native {
   @native def getLog(): String
 }
 
-object Pipeline extends NativeLoader("pdaljni.2.4") {
-  def apply(json: String): Pipeline = { val p = new Pipeline(json); p.initialize(); p }
+object Pipeline extends NativeLoader("pdaljni.2.5") {
+  def apply(json: String, logLevel: Int = LogLevel.Error): Pipeline = {
+    val p = new Pipeline(json, logLevel); p.initialize(); p
+  }
 }

core/src/test/resources/las-expected.json

@@ -0,0 +1,10 @@
+{
+  "pipeline": [
+    {
+      "filename": "core/src/test/resources/1.2-with-color.las",
+      "spatialreference": "EPSG:2993",
+      "tag": "readers_las1",
+      "type": "readers.las"
+    }
+  ]
+}

core/src/test/resources/metadata.json

@@ -0,0 +1,37 @@
+{
+  "metadata": {
+    "readers.las": [
+      {
+        "compressed": false,
+        "copc": false,
+        "count": 1065,
+        "creation_doy": 0,
+        "creation_year": 0,
+        "dataformat_id": 3,
+        "dataoffset": 229,
+        "filesource_id": 0,
+        "global_encoding": 0,
+        "global_encoding_base64": "AAA=",
+        "header_size": 227,
+        "major_version": 1,
+        "maxx": 638982.55,
+        "maxy": 853535.43,
+        "maxz": 586.38,
+        "minor_version": 2,
+        "minx": 635619.85,
+        "miny": 848899.7,
+        "minz": 406.59,
+        "offset_x": 0,
+        "offset_y": 0,
+        "offset_z": 0,
+        "point_length": 34,
+        "project_id": "00000000-0000-0000-0000-000000000000",
+        "scale_x": 0.01,
+        "scale_y": 0.01,
+        "scale_z": 0.01,
+        "software_id": "TerraScan",
+        "system_id": ""
+      }
+    ]
+  }
+}

core/src/test/resources/schema.json

@@ -0,0 +1,88 @@
+{
+  "schema":
+  {
+    "dimensions":
+    [
+      {
+        "name": "X",
+        "size": 8,
+        "type": "floating"
+      },
+      {
+        "name": "Y",
+        "size": 8,
+        "type": "floating"
+      },
+      {
+        "name": "Z",
+        "size": 8,
+        "type": "floating"
+      },
+      {
+        "name": "Intensity",
+        "size": 2,
+        "type": "unsigned"
+      },
+      {
+        "name": "ReturnNumber",
+        "size": 1,
+        "type": "unsigned"
+      },
+      {
+        "name": "NumberOfReturns",
+        "size": 1,
+        "type": "unsigned"
+      },
+      {
+        "name": "ScanDirectionFlag",
+        "size": 1,
+        "type": "unsigned"
+      },
+      {
+        "name": "EdgeOfFlightLine",
+        "size": 1,
+        "type": "unsigned"
+      },
+      {
+        "name": "Classification",
+        "size": 1,
+        "type": "unsigned"
+      },
+      {
+        "name": "ScanAngleRank",
+        "size": 4,
+        "type": "floating"
+      },
+      {
+        "name": "UserData",
+        "size": 1,
+        "type": "unsigned"
+      },
+      {
+        "name": "PointSourceId",
+        "size": 2,
+        "type": "unsigned"
+      },
+      {
+        "name": "GpsTime",
+        "size": 8,
+        "type": "floating"
+      },
+      {
+        "name": "Red",
+        "size": 2,
+        "type": "unsigned"
+      },
+      {
+        "name": "Green",
+        "size": 2,
+        "type": "unsigned"
+      },
+      {
+        "name": "Blue",
+        "size": 2,
+        "type": "unsigned"
+      }
+    ]
+  }
+}

core/src/test/scala/io/pdal/PipelineSpec.scala

@@ -24,6 +24,7 @@
 
 package io.pdal
 
+import io.circe.parser
 import java.nio.{ByteBuffer, ByteOrder}
 
 import scala.collection.JavaConverters._
@@ -34,7 +35,7 @@ class PipelineSpec extends TestEnvironmentSpec {
       val badPipeline = Pipeline(badJson)
       badPipeline.validate() should be(false)
       badPipeline.close()
-      (badPipeline.ptr() should be(0))
+      badPipeline.ptr() should be(0)
     }
 
     it("should validate json") {
@@ -160,23 +161,29 @@ class PipelineSpec extends TestEnvironmentSpec {
     it("should read crs correct") {
       val pvi = pipeline.getPointViews()
       val pv = pvi.next()
-      pv.getCrsProj4() should (be(proj4String).or(be(proj4StringMac)))
+      pv.getCrsProj4() should be(proj4String).or(be(proj4StringMac))
       pv.close()
       pvi.close()
     }
 
-    it("should fail with InitializationException") {
+    it("should fail with InitializationException when the input json is null") {
       intercept[InitializationException] { Pipeline(null) }
     }
 
-    it("should fail with ExecutionException") {
-      val pipeline = Pipeline("{")
-      intercept[ExecutionException] { pipeline.execute() }
-      intercept[ExecutionException] { pipeline.getPointViews() }
-      intercept[ExecutionException] { pipeline.getMetadata() }
-      intercept[ExecutionException] { pipeline.getSchema() }
+    it("should fail with ExecutionException when the input json is invalid") {
+      intercept[InitializationException] { Pipeline("{") }
+    }
+
+    it("should get pipeline") {
+      parser.parse(pipeline.getPipeline()) shouldBe jsonExpectedJson
+    }
+
+    it("should get schema") {
+      parser.parse(pipeline.getSchema()) shouldBe schemaJson
+    }
 
-      pipeline.close()
+    it("should get metadata") {
+      parser.parse(pipeline.getMetadata()) shouldBe metadataJson
     }
 
     it("should extract mesh in iterative fashion") {

core/src/test/scala/io/pdal/TestEnvironmentSpec.scala

@@ -24,6 +24,7 @@
 
 package io.pdal
 
+import io.circe.{parser, Json, ParsingFailure}
 import org.scalatest.BeforeAndAfterAll
 import org.scalatest.funspec.AnyFunSpec
 import org.scalatest.matchers.should.Matchers
@@ -52,6 +53,10 @@ trait TestEnvironmentSpec extends AnyFunSpec with Matchers with BeforeAndAfterAl
       |}
      """.stripMargin
 
+  val jsonExpectedJson: Either[ParsingFailure, Json] = parser.parse(getJson("/las-expected.json"))
+  val schemaJson: Either[ParsingFailure, Json] = parser.parse(getJson("/schema.json"))
+  val metadataJson: Either[ParsingFailure, Json] = parser.parse(getJson("/metadata.json"))
+
   val proj4String =
     "+proj=lcc +lat_0=41.75 +lon_0=-120.5 +lat_1=43 +lat_2=45.5 +x_0=400000 +y_0=0 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs"
   val proj4StringMac =