GeoServer Provenance Review - bencaradocdavies/geoserver GitHub Wiki

GeoServer Provenance Review

GeoServer code providence review, covering issues raised for each module in GeoServer. The goal here is to check the headers (fill them in if needed) and confirm that the information is correct. We can also list JIRA issues against any inconsistencies discovered.

Key Definition
❔ not checked yet
❓ check in progress
❓ ❗ check is stuck, header or license requires developer attention
βœ… βœ”οΈ checked, all clear
βœ… ❗ checked, warning (missing information)
βœ… ‼️ checked, fix me! requires developer attention

Review [Expectations and Examples](Expectations and Examples) to understand what a GeoServer header is expected to look like, and examples of how we can fix common mistakes.

Manual Review

Source Code

We are carefully checking java source file headers here, and exploring git (or even svn) history to double check where files came from.

We are less concerned with test cases, and test-data (as these are not distributed to end-users).

Extensions

Core

  • βœ…~~ Karin / JG
  • βœ…~~ JG
  • βœ…
  • βœ…~~ a lot of missing headers here

Community (EXCLUDED)

This review is limited to modules we are distributing for download to end-users. Community modules are considered a work in progress and will reviewed when they ready to be added to the project.

In a similar fashion build support modules and test plugins are not reviewed.

  • community

Build (EXCLUDED)

Build files also do not end up in the final distribution are excluded from this review:

  • maven/archetype
  • maven/config
  • maven/findbugs

Documentation

Documentation is expected to be under a license such as Creative Commons by Attribution:

Data

This is the data we distribute, we want to ensure we have obtained permission

Data

The priority is the data bundled with our application:

  • https://github.com/geoserver/geoserver/tree/master/data/release
    • βœ… "GEOS-5466β€œ:http://jira.codehaus.org/browse/GEOS-5466 Check release data license *** ARC Sample "Data provided by GeoSolutions with distribution permissions" *** βœ… IMG Sample”Data provided by GeoSolutions with distribution permissions" *** MOASIC Sample β€œData provided by GeoSolutions with distribution permissions” *** New York City β€œData provided by Open Planning Project with distribution permissions” *** Data provided by GRASS *** States~~ Comes from GeoTools sample data, and was simplified to reduce space usage. GeoTools copy came from Census data, though the original download file cannot be found at present.
    • βœ… Tasmania - Cameron indicates data derived from Digital Chart of the World
    • βœ… Update README.rst with details

With other data bundles as a second priority:

App-Schema

Minimal

We are not very worried about the test data included as part of the application build, it is not something end users run with.

CITE

Assume these have been provided by the OGC, we should have a LICENSE.TXT or something crediting the OGC.

*** https://github.com/geoserver/geoserver/tree/master/data/citecsw-2.0.2

*** https://github.com/geoserver/geoserver/tree/master/data/citewcs-1.0 (OGC does not provided data) *** https://github.com/geoserver/geoserver/tree/master/data/citewcs-1.1

*** https://github.com/geoserver/geoserver/tree/master/data/citewfs-1.0 *** https://github.com/geoserver/geoserver/tree/master/data/citewfs-1.1-h2 *** https://github.com/geoserver/geoserver/tree/master/data/citewfs-1.1 *** https://github.com/geoserver/geoserver/tree/master/data/citewms-1.1 *** https://github.com/geoserver/geoserver/tree/master/data/citewms-1.3

Research shows:

Automated

The manual review was backed up with an automated QA check.

Searches Used

Find files that do not have standard header:

find . -name "*.java" | xargs egrep -L -i -H '(.+)Copyright(.+)TOPP(.+)' {}

Files that do not have any header: {noformat} (?m)package List the .java files that DON’T include the text β€˜TOPP’: <pre> greprL β€˜TOPP’ * | grep β€˜\.java$’

Automated Shortlist -------------------

The following files have headers, but they are not the normal TOPP header - thus we know these are worth more attention ( βœ… good, ❗ missing headers, ❎ fix me):

validation

  • βœ… extension/validation/src/main/java/org/vfny/geoserver/config/validation/ArgumentConfig.java (GEOS-5426)
  • βœ… extension/validation/src/main/java/org/vfny/geoserver/config/validation/ValidationConfig.java (GEOS-5426)
  • βœ… extension/validation/src/main/java/org/vfny/geoserver/global/GeoValidator.java (GEOS-5426)

imagemap

  • βœ… extension/imagemap/src/main/java/org/vfny/geoserver/wms/responses/map/htmlimagemap/Decimator.java

wps

  • βœ… extension/wps/wps-core/src/main/java/org/geoserver/wps/ppio/JAIToolsRangeConverterFactory.java
  • βœ… extension/wps/wps-core/src/main/java/org/geoserver/wps/resource/CoverageResource.java
  • missing header
  • βœ… extension/wps/wps-core/src/main/java/org/geoserver/wps/resource/GridCoverageResource.java
  • missing header

gwc

  • βœ… gwc/src/main/java/org/geoserver/gwc/dispatch/package-info.java - missing header

main

  • βœ… main/test/org/vfny/geoserver/config/ValidationTest.java - GEOS-5455

main/src/main/java/org/vfny/geoserver/global/xml/NameSpaceElement.java~~ GEOS-5455 * main/src/main/java/org/vfny/geoserver/global/xml/GMLSchemaTranslator.java~~ GEOS-5455 * main/src/main/java/org/vfny/geoserver/global/xml/XMLSchemaTranslator.java~~ GEOS-5455 * main/src/main/java/org/vfny/geoserver/global/xml/NameSpaceTranslatorFactory.java~~ GEOS-5455 * main/src/main/java/org/vfny/geoserver/global/xml/NameSpaceTranslator.java~~ GEOS-5455 * main/src/main/java/org/vfny/geoserver/filters/SetCharacterEncodingFilter.java~~ Apache License Version 2.0 (GEOS-5470)

  • βœ… main/src/main/java/org/geoserver/jai/JAIInfo.java - seems fine?
  • βœ… main/src/main/java/org/geoserver/filters/GZIPFilter.java GEOS–5460
  • βœ… main/src/main/java/org/geoserver/filters/GZIPResponseWrapper.java GEOS–5460
  • βœ… main/src/main/java/org/geoserver/filters/GZIPResponseStream.java GEOS–5460

ows

  • βœ… ows/src/main/java/org/geoserver/ows/util/RewindableInputStream.java GEOS–5454
  • βœ… ows/src/main/java/org/geoserver/ows/util/UCSReader.java GEOS–5453

release

  • βœ… release/installer/mac/console/src/main/java/org/geoserver/console/Browser.java GEOS–5456

rest

  • βœ… rest/src/test/java/org/geoserver/rest/FormatTest.java.patch - um that looks like an accident (removed file)

wcs

  • βœ… wcs/src/main/java/org/geoserver/wcs/CoverageCleanerCallback.java
  • missing header

wcs1_1

  • βœ… wcs1_1/src/main/java/org/geoserver/wcs/xml/v1_1_1/bindings/TimeSequenceTypeBinding.java

  • βœ… wcs1_1/src/main/java/org/geoserver/wcs/xml/v1_1_1/bindings/TimePeriodTypeBinding.java GEOS–5459

web core

  • βœ… web/core/src/test/java/org/geoserver/web/ComponentBuilder.java - empty header

wfs

  • βœ… wfs/src/main/java/org/geoserver/wfs/xml/NameSpaceElement.java (GEOS-5455)
  • βœ… wfs/src/main/java/org/geoserver/wfs/xml/GMLSchemaTranslator.java (GEOS-5455)
  • βœ… wfs/src/main/java/org/geoserver/wfs/xml/XMLSchemaTranslator.java (GEOS-5455)
  • βœ… wfs/src/main/java/org/geoserver/wfs/xml/NameSpaceTranslatorFactory.java (GEOS-5455)
  • βœ… wfs/src/main/java/org/geoserver/wfs/xml/NameSpaceTranslator.java (GEOS-5455)
  • βœ… wfs/src/main/java/org/geoserver/wfs/JoinExtractingVisitor.java - missing header

wms

  • βœ… wms/src/test/java/org/geoserver/wms/WMSFilterMosaicTestSupport.java - missing header
  • βœ… wms/src/test/java/org/geoserver/wms/decoration/ScaleRatioDecorationTest.java
  • βœ… wms/src/test/java/org/geoserver/wms/map/quantize/ColorIndexerTest.java - GeoTools LGPL header (GEOS-5468)
  • βœ… wms/src/test/java/org/geoserver/wms/wms11_1/LayerGroupWorkspaceTest.java
  • missing header
  • βœ… wms/src/main/java/org/geoserver/wms/map/quantize/ColorIndexerCRIF.java - GeoTools LGPL header (GEOS-5468)
  • βœ… wms/src/main/java/org/geoserver/wms/map/quantize/ColorIndexerOpImage.java
  • βœ… wms/src/main/java/org/geoserver/wms/map/quantize/ColorIndexerDescriptor.java
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️