geoserver: add extensions and update script

[rollf]

Description of changes

This PR adds the possibility to run geoserver with extensions. This is achieved by adding the function geoserver.[passthru.]withExtensions that expects a selector function that selects extensions among a given list and returns a geoserver derivation with the selected extensions installed. Example:

geoserverWithImporterExtension = pkgs.geoserver.withExtensions (ps: with ps; [ importer ]);

All extensions are listed in a new file geoserver/extensions.nix. They are fed to withExtensions upon invocation. The standard procedure to install extensions is followed (i.e. unpack extension content into geoserver/webapps/geoserver/WEB-INF/lib). My initial implementation used symlinkJoin. While the server starts, trying to access it results in java.io.FileNotFoundException: Could not open ServletContext resource [/WEB-INF/dispatcher-servlet.xml]. Besides, the wrappers (geoserver-startup, geoserver-shutdown) would have to be rewritten. So the current implementation copies the files from the extension's $out into geoserver's $out. Some extensions have dependencies. This is coped with. Some extensions do not work currently. Those are commented out for now.

Since there are >50 extensions, an update.sh script has been added to automatically update both geoserver as well as all extensions. The script is designed to work by either fetching the latest Geoserver version from GitHub or by providing specific versions. Example:

cd nixpkgs
export DEBUG=1
export UPDATE_NIX_OLD_VERSION=2.24.1
export UPDATE_NIX_NEW_VERSION=2.24.2
./pkgs/servers/geospatial/geoserver/update.sh # update geoserver + all plugins
./pkgs/servers/geospatial/geoserver/update.sh importer # update geoserver + importer plugin

passthru.updateScript is set to this new script and things should work as intended (see Nixpkgs manual section on passthru.updateScript)

nixos/tests/geoserver.nix has been adapted to test several geoserver installations. Crucially, a test is run with (nearly) all extensions enabled. This test checks for known issues in the log file.

I think there is room for improvement in this PR and I'm happy to work in comments. Overall, I think the approach is sound.

ToDos:

• Add entry to "Other Notable Changes" in the 24.05 release notes?

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
  • sandbox = relaxed
  • sandbox = true
• Tested, as applicable:
  • NixOS test(s) (look inside nixos/tests)
  • and/or package tests
  • or, for functions and "core" functionality, tests in lib/tests or pkgs/test
  • made sure NixOS tests are linked to the relevant packages
• Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
• Tested basic functionality of all binary files (usually in ./result/bin/)
• 24.05 Release Notes (or backporting 23.05 and 23.11 Release notes)
  • (Package updates) Added a release notes entry if the change is major or breaking
  • (Module updates) Added a release notes entry if the change is significant
  • (Module addition) Added a release notes entry if adding a new NixOS module
• Fits CONTRIBUTING.md.

---

Add a 👍 reaction to pull requests you find important.

[imincik]

Looks like a good job @rollf ! I'll review it soon.

[nixos-discourse]

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/week-in-geospatial-team/37035/7

[imincik]

I tried to build the package with and without extensions, tried to run update script and checked the code. I like the usage of the geoserver.[passthru.]withExtensions.

Looks good OK to me. Thank you @rollf .

[rollf]

Okay, thank you @imincik . I had seen before the label of borg internal error. I think this was me when I polished the PR (I don't remember correctly what it was, maybe I added a syntax error or so). I will remove this label now by hand because the ofborg-eval has been "pending" now for several days.

[rollf]

With the release of nix 2.20.0, the invocation of nix hash to-sri ... could be modified to nix hash convert --to sri ... (see release docs). Should I do this right now? I wouldn't know how, though. I'd need to force the script to run nix >= 2.20.0.

[rollf]

ofborg-eval doesn't seem to run at all.

[imincik]

ofborg-eval doesn't seem to run at all.

Can you try to force-push to this PR ? It might help to restart eval.

[imincik]

With the release of nix 2.20.0, the invocation of nix hash to-sri ... could be modified to nix hash convert --to sri ... (see release docs). Should I do this right now? I wouldn't know how, though. I'd need to force the script to run nix >= 2.20.0.

Oh, I missed this command. I think we shouldn't use new/experimental CLI in nixpkgs. I suggest to replace it with nix-hash --to-sri. This is actually a good example of the reason why we should stick with old CLI until the new one is stable.

[imincik]

@rollf , thanks for your work !

[nixos-discourse]

This pull request has been mentioned on NixOS Discourse. There might be relevant details there:

https://discourse.nixos.org/t/week-in-geospatial-team/37035/8