commit 98fbcf17888872f5ebdf9fb6247266929f4308db · pyrox.dev/nixpkgs

doc/doc-support/default.nix

···

       12
        
           { name = "lists"; description = "list manipulation functions"; }

     

       13
        
           { name = "debug"; description = "debugging functions"; }

     

       14
        
           { name = "options"; description = "NixOS / nixpkgs option handling"; }

     

       0
        
       
     

       15
        
           { name = "filesystem"; description = "filesystem functions"; }

     

       16
        
           { name = "sources"; description = "source filtering functions"; }

     

       17
        
           { name = "cli"; description = "command-line serialization functions"; }

···

       12
        
           { name = "lists"; description = "list manipulation functions"; }

     

       13
        
           { name = "debug"; description = "debugging functions"; }

     

       14
        
           { name = "options"; description = "NixOS / nixpkgs option handling"; }

     

       15
       +
           { name = "path"; description = "path functions"; }

     

       16
        
           { name = "filesystem"; description = "filesystem functions"; }

     

       17
        
           { name = "sources"; description = "source filtering functions"; }

     

       18
        
           { name = "cli"; description = "command-line serialization functions"; }

+2 -1

lib/default.nix

···

       27
        
           maintainers = import ../maintainers/maintainer-list.nix;

     

       28
        
           teams = callLibs ../maintainers/team-list.nix;

     

       29
        
           meta = callLibs ./meta.nix;

     

       30
       -
           sources = callLibs ./sources.nix;

     

       31
        
           versions = callLibs ./versions.nix;

     

       32
        
       

     

       33
        
           # module system

     
···

       53
        
           fetchers = callLibs ./fetchers.nix;

     

       54
        
       

     

       55
        
           # Eval-time filesystem handling

     

       0
        
       
     

       56
        
           filesystem = callLibs ./filesystem.nix;

     

       0
        
       
     

       57
        
       

     

       58
        
           # back-compat aliases

     

       59
        
           platforms = self.systems.doubles;

···

       27
        
           maintainers = import ../maintainers/maintainer-list.nix;

     

       28
        
           teams = callLibs ../maintainers/team-list.nix;

     

       29
        
           meta = callLibs ./meta.nix;

     

       0
        
       
     

       30
        
           versions = callLibs ./versions.nix;

     

       31
        
       

     

       32
        
           # module system

     
···

       52
        
           fetchers = callLibs ./fetchers.nix;

     

       53
        
       

     

       54
        
           # Eval-time filesystem handling

     

       55
       +
           path = callLibs ./path;

     

       56
        
           filesystem = callLibs ./filesystem.nix;

     

       57
       +
           sources = callLibs ./sources.nix;

     

       58
        
       

     

       59
        
           # back-compat aliases

     

       60
        
           platforms = self.systems.doubles;

+75

lib/path/default.nix

···

       1
       +
       # Functions for working with paths, see ./path.md

     

       2
       +
       { lib }:

     

       3
       +
       let

     

       4
       +
       

     

       5
       +
         inherit (builtins)

     

       6
       +
           isString

     

       7
       +
           match

     

       8
       +
           ;

     

       9
       +
       

     

       10
       +
         inherit (lib.strings)

     

       11
       +
           substring

     

       12
       +
           ;

     

       13
       +
       

     

       14
       +
         inherit (lib.asserts)

     

       15
       +
           assertMsg

     

       16
       +
           ;

     

       17
       +
       

     

       18
       +
         # Return the reason why a subpath is invalid, or `null` if it's valid

     

       19
       +
         subpathInvalidReason = value:

     

       20
       +
           if ! isString value then

     

       21
       +
             "The given value is of type ${builtins.typeOf value}, but a string was expected"

     

       22
       +
           else if value == "" then

     

       23
       +
             "The given string is empty"

     

       24
       +
           else if substring 0 1 value == "/" then

     

       25
       +
             "The given string \"${value}\" starts with a `/`, representing an absolute path"

     

       26
       +
           # We don't support ".." components, see ./path.md#parent-directory

     

       27
       +
           else if match "(.*/)?\\.\\.(/.*)?" value != null then

     

       28
       +
             "The given string \"${value}\" contains a `..` component, which is not allowed in subpaths"

     

       29
       +
           else null;

     

       30
       +
       

     

       31
       +
       in /* No rec! Add dependencies on this file at the top. */ {

     

       32
       +
       

     

       33
       +
       

     

       34
       +
         /* Whether a value is a valid subpath string.

     

       35
       +
       

     

       36
       +
         - The value is a string

     

       37
       +
       

     

       38
       +
         - The string is not empty

     

       39
       +
       

     

       40
       +
         - The string doesn't start with a `/`

     

       41
       +
       

     

       42
       +
         - The string doesn't contain any `..` path components

     

       43
       +
       

     

       44
       +
         Type:

     

       45
       +
           subpath.isValid :: String -> Bool

     

       46
       +
       

     

       47
       +
         Example:

     

       48
       +
           # Not a string

     

       49
       +
           subpath.isValid null

     

       50
       +
           => false

     

       51
       +
       

     

       52
       +
           # Empty string

     

       53
       +
           subpath.isValid ""

     

       54
       +
           => false

     

       55
       +
       

     

       56
       +
           # Absolute path

     

       57
       +
           subpath.isValid "/foo"

     

       58
       +
           => false

     

       59
       +
       

     

       60
       +
           # Contains a `..` path component

     

       61
       +
           subpath.isValid "../foo"

     

       62
       +
           => false

     

       63
       +
       

     

       64
       +
           # Valid subpath

     

       65
       +
           subpath.isValid "foo/bar"

     

       66
       +
           => true

     

       67
       +
       

     

       68
       +
           # Doesn't need to be normalised

     

       69
       +
           subpath.isValid "./foo//bar/"

     

       70
       +
           => true

     

       71
       +
         */

     

       72
       +
         subpath.isValid = value:

     

       73
       +
           subpathInvalidReason value == null;

     

       74
       +
       

     

       75
       +
       }

+27

lib/path/tests/default.nix

···

       1
       +
       {

     

       2
       +
         nixpkgs ? ../../..,

     

       3
       +
         system ? builtins.currentSystem,

     

       4
       +
         pkgs ? import nixpkgs {

     

       5
       +
           config = {};

     

       6
       +
           overlays = [];

     

       7
       +
           inherit system;

     

       8
       +
         },

     

       9
       +
         libpath ? ../..,

     

       10
       +
       }:

     

       11
       +
       pkgs.runCommand "lib-path-tests" {

     

       12
       +
         nativeBuildInputs = with pkgs; [

     

       13
       +
           nix

     

       14
       +
         ];

     

       15
       +
       } ''

     

       16
       +
         # Needed to make Nix evaluation work

     

       17
       +
         export NIX_STATE_DIR=$(mktemp -d)

     

       18
       +
       

     

       19
       +
         cp -r ${libpath} lib

     

       20
       +
         export TEST_LIB=$PWD/lib

     

       21
       +
       

     

       22
       +
         echo "Running unit tests lib/path/tests/unit.nix"

     

       23
       +
         nix-instantiate --eval lib/path/tests/unit.nix \

     

       24
       +
           --argstr libpath "$TEST_LIB"

     

       25
       +
       

     

       26
       +
         touch $out

     

       27
       +
       ''

+76

lib/path/tests/unit.nix

···

       1
       +
       # Unit tests for lib.path functions. Use `nix-build` in this directory to

     

       2
       +
       # run these

     

       3
       +
       { libpath }:

     

       4
       +
       let

     

       5
       +
         lib = import libpath;

     

       6
       +
         inherit (lib.path) subpath;

     

       7
       +
       

     

       8
       +
         cases = lib.runTests {

     

       9
       +
           testSubpathIsValidExample1 = {

     

       10
       +
             expr = subpath.isValid null;

     

       11
       +
             expected = false;

     

       12
       +
           };

     

       13
       +
           testSubpathIsValidExample2 = {

     

       14
       +
             expr = subpath.isValid "";

     

       15
       +
             expected = false;

     

       16
       +
           };

     

       17
       +
           testSubpathIsValidExample3 = {

     

       18
       +
             expr = subpath.isValid "/foo";

     

       19
       +
             expected = false;

     

       20
       +
           };

     

       21
       +
           testSubpathIsValidExample4 = {

     

       22
       +
             expr = subpath.isValid "../foo";

     

       23
       +
             expected = false;

     

       24
       +
           };

     

       25
       +
           testSubpathIsValidExample5 = {

     

       26
       +
             expr = subpath.isValid "foo/bar";

     

       27
       +
             expected = true;

     

       28
       +
           };

     

       29
       +
           testSubpathIsValidExample6 = {

     

       30
       +
             expr = subpath.isValid "./foo//bar/";

     

       31
       +
             expected = true;

     

       32
       +
           };

     

       33
       +
           testSubpathIsValidTwoDotsEnd = {

     

       34
       +
             expr = subpath.isValid "foo/..";

     

       35
       +
             expected = false;

     

       36
       +
           };

     

       37
       +
           testSubpathIsValidTwoDotsMiddle = {

     

       38
       +
             expr = subpath.isValid "foo/../bar";

     

       39
       +
             expected = false;

     

       40
       +
           };

     

       41
       +
           testSubpathIsValidTwoDotsPrefix = {

     

       42
       +
             expr = subpath.isValid "..foo";

     

       43
       +
             expected = true;

     

       44
       +
           };

     

       45
       +
           testSubpathIsValidTwoDotsSuffix = {

     

       46
       +
             expr = subpath.isValid "foo..";

     

       47
       +
             expected = true;

     

       48
       +
           };

     

       49
       +
           testSubpathIsValidTwoDotsPrefixComponent = {

     

       50
       +
             expr = subpath.isValid "foo/..bar/baz";

     

       51
       +
             expected = true;

     

       52
       +
           };

     

       53
       +
           testSubpathIsValidTwoDotsSuffixComponent = {

     

       54
       +
             expr = subpath.isValid "foo/bar../baz";

     

       55
       +
             expected = true;

     

       56
       +
           };

     

       57
       +
           testSubpathIsValidThreeDots = {

     

       58
       +
             expr = subpath.isValid "...";

     

       59
       +
             expected = true;

     

       60
       +
           };

     

       61
       +
           testSubpathIsValidFourDots = {

     

       62
       +
             expr = subpath.isValid "....";

     

       63
       +
             expected = true;

     

       64
       +
           };

     

       65
       +
           testSubpathIsValidThreeDotsComponent = {

     

       66
       +
             expr = subpath.isValid "foo/.../bar";

     

       67
       +
             expected = true;

     

       68
       +
           };

     

       69
       +
           testSubpathIsValidFourDotsComponent = {

     

       70
       +
             expr = subpath.isValid "foo/..../bar";

     

       71
       +
             expected = true;

     

       72
       +
           };

     

       73
       +
         };

     

       74
       +
       in

     

       75
       +
         if cases == [] then "Unit tests successful"

     

       76
       +
         else throw "Path unit tests failed: ${lib.generators.toPretty {} cases}"

lib/tests/release.nix

···

       15
        
             inherit pkgs;

     

       16
        
             lib = import ../.;

     

       17
        
           })

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       18
        
         ];

     

       19
        
       } ''

     

       20
        
           datadir="${pkgs.nix}/share"

···

       15
        
             inherit pkgs;

     

       16
        
             lib = import ../.;

     

       17
        
           })

     

       18
       +
           (import ../path/tests {

     

       19
       +
             inherit pkgs;

     

       20
       +
           })

     

       21
        
         ];

     

       22
        
       } ''

     

       23
        
           datadir="${pkgs.nix}/share"