bumblebee-status: init at 2.2.0

[augustebaum]

Description of changes

This creates a package for bumblebee-status, a status program for use with the i3 window manager (or similar).

Because the bumblebee-status includes a large number of plugins within its source code (see here for the docs and here for the source code), each with its own set of dependencies, the package can be overriden in the form of the argument withPlugins, which is the list of plugins to get the dependencies for. By default the list is empty (i.e. no extra dependencies are installed, although the program still has access to the plugins).

Hence this PR includes two packages: bumblebee-status, and bumblebee-status-full for which all plugin dependencies are added as propagatedBuildInputs.

Things done

• Built on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
• For non-Linux: Is sandbox = true set in nix.conf? (See Nix manual)
• 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/)
• 23.11 Release Notes (or backporting 23.05 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.

[augustebaum]

Some things to note:

• Since the plugins are all contained within the bumblebee-status repo, the withPlugins override doesn't actually install plugins but rather their propagatedBuildInputs (i.e., kind of, runtime dependencies);
• Not all plugins have their dependencies packaged with Nix so I've implemented some logic for marking when a dependency is missing; however, I haven't figured out how to actually print warnings.

[augustebaum]

@imincik @lorenzleutgeb @andres-nav for your consideration.

[andres-nav]

First of all, you need to separate the changes in two commits. One adding you as a maintiner, and the other one adding the package, see #233506. Also it is better to get the source code from Github in my opinion. For the tests, it is better to disable the tests that don't work, not all of them. And it should be alphabetically ordered in all-packages.

[lorenzleutgeb]

Very clean job, nice!

One thing I don't understand is why you chose to have a list of plugins. Both the filtering and generation of the list of names of plugins are a little unwieldy. If plugins.nix would expose an attribute set, consuming them would be selectedPlugins = lib.filterAttrs (name: _: builtins.elem name withPlugins) allPlugins, a list of plugins names would be allPluginNames = builtins.attrNames allPlugins and you might even be able to get rid of all the name = "..." noise in plugins.nix. In case you have a good reason (which apparently I do not comprehend), just ignore this comment.

[augustebaum]

One thing I don't understand is why you chose to have a list of plugins

@lorenzleutgeb It used to be an attribute set, but I need the name for the warning messages... which are currently unused right now. Will think about this some more.

[augustebaum]

Update:

• Added tests (which required switching to fetchFromGithub)
• Adding myself to the Nixpkgs maintainers list is now a separate commit
• Implemented warnings about non-existent plugin dependencies

[augustebaum]

Hopefully final update: in the end I'd rather not package plugins with missing dependencies at all. The plugins in question are not all relevant for NixOS in any case (e.g. the ones that check the status of some other Linux package manager), but hopefully the remaining ones can be packaged at some point.

[imincik]

Good work @augustebaum

[augustebaum]

Remove redundant bumblebee-status-full package variant.

[nixos-discourse]

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

https://discourse.nixos.org/t/prs-ready-for-review/3032/2697

[lorenzleutgeb]

Only minor comments. Still very clean, and IMO good to merge!

[infinisil]

We sat together at #ZurichZHF, I have some suggestions against this branch: augustebaum#1

[infinisil]

Went through some iterations with @augustebaum at #ZurichZHF, looking great now!

[augustebaum]

Thanks for the thoughtful review!

[imincik]

Congratulations @augustebaum !