MirrorHub/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-15 14:26:33 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
nixpkgs/lib
History
Adam Joseph 54c9a08aaf lib.tests: build nix without flaky aws-sdk-cpp 
The aws-sdk-cpp tests are flaky.

Since pull requests to staging cause nix to be rebuilt, this means
that staging PRs end up getting false CI failures due to whatever is
flaky in the AWS SDK tests.  Since none of our CI needs to (or
should be able to) contact AWS S3, let's just omit it all.  Bonus:
the tests build way faster.
2023-11-18 20:19:10 -08:00
..
fileset lib.fileset: Add an additional argument in the design docs 2023-11-01 22:38:48 +01:00
path lib.tests: build nix without flaky aws-sdk-cpp 2023-11-18 20:19:10 -08:00
systems lib.systems.inspect: add patternLogicalAnd 2023-11-05 00:55:16 +00:00
tests lib.tests: build nix without flaky aws-sdk-cpp 2023-11-18 20:19:10 -08:00
ascii-table.nix
asserts.nix
attrsets.nix Merge pull request #254452 from flyingcircusio/lib-attrsToList 2023-10-10 19:49:17 +02:00
cli.nix
customisation.nix lib.makeScopeWithSplicing': add comments 2023-11-02 17:47:02 +02:00
debug.nix
default.nix Merge pull request #254452 from flyingcircusio/lib-attrsToList 2023-10-10 19:49:17 +02:00
deprecated.nix
derivations.nix
fetchers.nix
filesystem.nix
fixed-points.nix lib/fixed-points.nix: correct typo 2023-10-31 11:45:51 -07:00
flake.nix
generators.nix
gvariant.nix
kernel.nix
licenses.nix lib.licenses: nvidia*: add shortName-s 2023-11-08 19:06:44 -03:00
lists.nix lib.lists.foldl': Make strict in the initial accumulator 2023-09-27 02:43:59 +02:00
meta.nix lib.getExe': check arguments 2023-10-16 18:52:56 -04:00
minver.nix
modules.nix Merge pull request #249243 from lf-/jade/declarationsWithLocations 2023-09-17 19:43:07 +02:00
options.nix lib/options: refactor mkPackageOption 2023-10-10 13:14:17 +02:00
README.md
source-types.nix
sources.nix
strings-with-deps.nix
strings.nix lib.strings: add replicate 2023-10-31 20:25:41 +01:00
trivial.nix
types.nix
versions.nix
zip-int-bits.nix

README.md

Nixpkgs lib

This directory contains the implementation, documentation and tests for the Nixpkgs lib library.

Overview

The evaluation entry point for lib is default.nix. This file evaluates to an attribute set containing two separate kinds of attributes:

  • Sub-libraries: Attribute sets grouping together similar functionality. Each sub-library is defined in a separate file usually matching its attribute name.

    Example: lib.lists is a sub-library containing list-related functionality such as lib.lists.take and lib.lists.imap0. These are defined in the file lists.nix.

  • Aliases: Attributes that point to an attribute of the same name in some sub-library.

    Example: lib.take is an alias for lib.lists.take.

Most files in this directory are definitions of sub-libraries, but there are a few others:

  • minver.nix: A string of the minimum version of Nix that is required to evaluate Nixpkgs.
  • tests: Tests, see Running tests
    • release.nix: A derivation aggregating all tests
    • misc.nix: Evaluation unit tests for most sub-libraries
    • *.sh: Bash scripts that run tests for specific sub-libraries
    • All other files in this directory exist to support the tests
  • systems: The lib.systems sub-library, structured into a directory instead of a file due to its complexity
  • path: The lib.path sub-library, which includes tests as well as a document describing the design goals of lib.path
  • All other files in this directory are sub-libraries

Module system

The module system spans multiple sub-libraries:

  • modules.nix: lib.modules for the core functions and anything not relating to option definitions
  • options.nix: lib.options for anything relating to option definitions
  • types.nix: lib.types for module system types

Reference documentation

Reference documentation for library functions is written above each function as a multi-line comment. These comments are processed using nixdoc and rendered in the Nixpkgs manual. The nixdoc README describes the comment format.

See the chapter on contributing to the Nixpkgs manual for how to build the manual.

Running tests

All library tests can be run by building the derivation in tests/release.nix:

nix-build tests/release.nix

Some commands for quicker iteration over parts of the test suite are also available:

# Run all evaluation unit tests in tests/misc.nix
# if the resulting list is empty, all tests passed
nix-instantiate --eval --strict tests/misc.nix

# Run the module system tests
tests/modules.sh

# Run the lib.sources tests
tests/sources.sh

# Run the lib.filesystem tests
tests/filesystem.sh

# Run the lib.path property tests
path/tests/prop.sh

# Run the lib.fileset tests
fileset/tests.sh