locationtech / locationtech/proj4j

Develop approach to run PROJ.4 unit tests

Open
#9 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
232
Forks
86
PR merge metrics
No merged PRs in 30d

Description

It would be great to be able to run all or most of the PROJ.4 unit tests against Proj4J.

It appears that the current testing framework for PROJ.4 uses a custom utility called GIE. This reads a custom format originating in a test utility called GIGS. There are a LOT of unit tests.

Possible approaches:

  1. Port the unit tests to a format which Proj4J can run. This should be a declarative format, for maximum usabliy and ease of maintenance. The current MetaCRS CSV format is too hard to work with IMHO - a better format should be devised. This will also require a transpiler from the GIE format to the Proj4J format.

  2. Develop a test runner that can handle the GIGS/GIE format directly. Hopefully this won't be too hard. The advantage here is that it will be easier to keep the tests in synch with PROJ.4

Note that it is very likely that not all PROJ4 tests will run in Proj4J, due to differences in supported functionality. There will need to be a way to indicate which tests should not be run (or transpiled)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the GIE utility in src/gie.c and the test cases in test/gigs to understand the existing format and coverage. Compare those inputs with Proj4J's current testing framework and the MetaCRS CSV format. Done means a documented approach and a working way to run an appropriate subset of PROJ.4 tests, with unsupported cases identified.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, java
Domain
testing-qa, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.