Unverified Commit 2d104c99 authored by github-actions[bot]'s avatar github-actions[bot] Committed by GitHub
Browse files

Merge master into staging-next

parents b08ae54d d86f2119

README.md

+2 −2
Original line number Diff line number Diff line
@@ -46,9 +46,9 @@ Nixpkgs and NixOS are built and tested by our continuous integration 
system, [Hydra](https://hydra.nixos.org/).



* [Continuous package builds for unstable/master](https://hydra.nixos.org/jobset/nixos/trunk-combined)

* [Continuous package builds for the NixOS 20.09 release](https://hydra.nixos.org/jobset/nixos/release-20.09)

* [Continuous package builds for the NixOS 21.05 release](https://hydra.nixos.org/jobset/nixos/release-21.05)

* [Tests for unstable/master](https://hydra.nixos.org/job/nixos/trunk-combined/tested#tabs-constituents)

* [Tests for the NixOS 20.09 release](https://hydra.nixos.org/job/nixos/release-20.09/tested#tabs-constituents)

* [Tests for the NixOS 21.05 release](https://hydra.nixos.org/job/nixos/release-21.05/tested#tabs-constituents)



Artifacts successfully built with Hydra are published to cache at

https://cache.nixos.org/. When successful build and test criteria are

doc/languages-frameworks/gnome.section.md

+19 −1
Original line number Diff line number Diff line
@@ -8,12 +8,30 @@ Programs in the GNOME universe are written in various languages but they all use 


[GSettings](https://developer.gnome.org/gio/stable/GSettings.html) API is often used for storing settings. GSettings schemas are required, to know the type and other metadata of the stored values. GLib looks for `glib-2.0/schemas/gschemas.compiled` files inside the directories of `XDG_DATA_DIRS`.



On Linux, GSettings API is implemented using [dconf](https://wiki.gnome.org/Projects/dconf) backend. You will need to add `dconf` GIO module to `GIO_EXTRA_MODULES` variable, otherwise the `memory` backend will be used and the saved settings will not be persistent.

On Linux, GSettings API is implemented using [dconf](https://wiki.gnome.org/Projects/dconf) backend. You will need to add `dconf` [GIO module](#ssec-gnome-gio-modules) to `GIO_EXTRA_MODULES` variable, otherwise the `memory` backend will be used and the saved settings will not be persistent.



Last you will need the dconf database D-Bus service itself. You can enable it using `programs.dconf.enable`.



Some applications will also require `gsettings-desktop-schemas` for things like reading proxy configuration or user interface customization. This dependency is often not mentioned by upstream, you should grep for `org.gnome.desktop` and `org.gnome.system` to see if the schemas are needed.



### GIO modules {#ssec-gnome-gio-modules}



GLib’s [GIO](https://developer.gnome.org/gio/stable/ch01.html) library supports several [extension points](https://developer.gnome.org/gio/stable/extending-gio.html). Notably, they allow:



* implementing settings backends (already [mentioned](#ssec-gnome-settings))

* adding TLS support

* proxy settings

* virtual file systems



The modules are typically installed to `lib/gio/modules/` directory of a package and you need to add them to `GIO_EXTRA_MODULES` if you need any of those features.



In particular, we recommend:



* adding `dconf.lib` for any software on Linux that reads [GSettings](#ssec-gnome-settings) (even transitivily through e.g. GTK’s file manager)

* adding `glib-networking` for any software that accesses network using GIO or libsoup – glib-networking contains a module that implements TLS support and loads system-wide proxy settings



To allow software to use various virtual file systems, `gvfs` package can be also added. But that is usually an optional feature so we typically use `gvfs` from the system (e.g. installed globally using NixOS module).



### GdkPixbuf loaders {#ssec-gnome-gdk-pixbuf-loaders}



GTK applications typically use [GdkPixbuf](https://developer.gnome.org/gdk-pixbuf/stable/) to load images. But `gdk-pixbuf` package only supports basic bitmap formats like JPEG, PNG or TIFF, requiring to use third-party loader modules for other formats. This is especially painful since GTK itself includes SVG icons, which cannot be rendered without a loader provided by `librsvg`.

maintainers/maintainer-list.nix

+5 −0
Original line number Diff line number Diff line
@@ -7281,6 +7281,11 @@ 
    githubId = 628342;

    name = "Tim Steinbach";

  };

  nessdoor = {

    name = "Tomas Antonio Lopez";

    email = "entropy.overseer@protonmail.com";

    githubId = 25993494;

  };

  netcrns = {

    email = "jason.wing@gmx.de";

    github = "netcrns";

nixos/lib/test-driver/test-driver.py

+1 −1
Original line number Diff line number Diff line
@@ -973,7 +973,7 @@ def subtest(name: str) -> Iterator[None]: 




if __name__ == "__main__":

    arg_parser = argparse.ArgumentParser()

    arg_parser = argparse.ArgumentParser(prog="nixos-test-driver")

    arg_parser.add_argument(

        "-K",

        "--keep-vm-state",

nixos/lib/testing-python.nix

+135 −122
Original line number Diff line number Diff line
@@ -16,13 +16,19 @@ rec { 


  inherit pkgs;





  mkTestDriver =

  # Reifies and correctly wraps the python test driver for

  # the respective qemu version and with or without ocr support

  pythonTestDriver = {

      qemu_pkg ? pkgs.qemu_test

    , enableOCR ? false

  }:

    let

      testDriverScript = ./test-driver/test-driver.py;

    in

    qemu_pkg: stdenv.mkDerivation {

      name = "nixos-test-driver";

      testDriverScript = ./test-driver/test-driver.py;

      ocrProg = tesseract4.override { enableLanguages = [ "eng" ]; };

      imagemagick_tiff = imagemagick_light.override { inherit libtiff; };

    in stdenv.mkDerivation {

      inherit name;



      nativeBuildInputs = [ makeWrapper ];

      buildInputs = [ (python3.withPackages (p: [ p.ptpython p.colorama ])) ];
@@ -35,7 +41,7 @@ rec { 
      buildPhase = ''

        python <<EOF

        from pydoc import importfile

        with open('driver-exports', 'w') as fp:

        with open('driver-symbols', 'w') as fp:

          fp.write(','.join(dir(importfile('${testDriverScript}'))))

        EOF

      '';
@@ -57,20 +63,17 @@ rec { 
          # TODO: copy user script part into this file (append)



          wrapProgram $out/bin/nixos-test-driver \

            --argv0 ${name} \

            --prefix PATH : "${lib.makeBinPath [ qemu_pkg vde2 netpbm coreutils ]}" \

            ${lib.optionalString enableOCR

              "--prefix PATH : '${ocrProg}/bin:${imagemagick_tiff}/bin'"} \



          install -m 0644 -vD driver-exports $out/nix-support/driver-exports

          install -m 0644 -vD driver-symbols $out/nix-support/driver-symbols

        '';

    };



  # Run an automated test suite in the given virtual network.

  runTests = {

    # the script that runs the network

    driver,

    # a source position in the format of builtins.unsafeGetAttrPos

    # for meta.position

    pos,

  }:

  runTests = { driver, pos }:

    stdenv.mkDerivation {

      name = "vm-test-run-${driver.testName}";
@@ -87,87 +90,70 @@ rec { 
        inherit driver;

      };



      inherit pos;

      inherit pos; # for better debugging

    };





  makeTest =

    { testScript

  # Generate convenience wrappers for running the test driver

  # has vlans, vms and test script defaulted through env variables

  # also instantiates test script with nodes, if it's a function (contract)

  setupDriverForTest = {

      testScript

    , testName

    , nodes

    , qemu_pkg ? pkgs.qemu_test

    , enableOCR ? false

    , name ? "unnamed"

      # Skip linting (mainly intended for faster dev cycles)

    , skipLint ? false

    , passthru ? {}

    , # For meta.position

      pos ? # position used in error messages and for meta.position

        (if t.meta.description or null != null

          then builtins.unsafeGetAttrPos "description" t.meta

          else builtins.unsafeGetAttrPos "testScript" t)

    , ...

    } @ t:

  }:

    let

      # FIXME: get this pkg from the module system

      testDriver = pythonTestDriver { inherit qemu_pkg enableOCR;};



      testDriverName =

        let

          # A standard store path to the vm monitor is built like this:

          #   /tmp/nix-build-vm-test-run-$name.drv-0/vm-state-machine/monitor

          # The max filename length of a unix domain socket is 108 bytes.

          # This means $name can at most be 50 bytes long.

          maxTestNameLen = 50;

      testNameLen = builtins.stringLength name;







      ocrProg = tesseract4.override { enableLanguages = [ "eng" ]; };



      imagemagick_tiff = imagemagick_light.override { inherit libtiff; };



      # Generate convenience wrappers for running the test driver

      # interactively with the specified network, and for starting the

      # VMs from the command line.

      mkDriver = qemu_pkg:

        let

          build-vms = import ./build-vms.nix {

            inherit system pkgs minimal specialArgs;

            extraConfigurations = extraConfigurations ++ (pkgs.lib.optional (qemu_pkg != null)

              {

                virtualisation.qemu.package = qemu_pkg;

              }

            ) ++ [(

              {

                # Ensure we do not use aliases. Ideally this is only set

                # when the test framework is used by Nixpkgs NixOS tests.

                nixpkgs.config.allowAliases = false;

              }

            )];

          };



          # FIXME: get this pkg from the module system

          testDriver = mkTestDriver (if qemu_pkg == null then pkgs.qemu_test else qemu_pkg);

          testNameLen = builtins.stringLength testName;

        in with builtins;

          if testNameLen > maxTestNameLen then

            abort

              ("The name of the test '${testName}' must not be longer than ${toString maxTestNameLen} " +

                "it's currently ${toString testNameLen} characters long.")

          else

            "nixos-test-driver-${testName}";



          nodes = build-vms.buildVirtualNetwork (

            t.nodes or (if t ? machine then { machine = t.machine; } else { })

          );

      vlans = map (m: m.config.virtualisation.vlans) (lib.attrValues nodes);

      vms = map (m: m.config.system.build.vm) (lib.attrValues nodes);



      nodeHostNames = map (c: c.config.system.name) (lib.attrValues nodes);



      invalidNodeNames = lib.filter

        (node: builtins.match "^[A-z_]([A-z0-9_]+)?$" node == null)

        (builtins.attrNames nodes);



      testScript' =

        # Call the test script with the computed nodes.

        if lib.isFunction testScript

        then testScript { inherit nodes; }

        else testScript;



          testDriverName = with builtins;

            if testNameLen > maxTestNameLen then

              abort

                ("The name of the test '${name}' must not be longer than ${toString maxTestNameLen} " +

                  "it's currently ${toString testNameLen} characters long.")

            else

              "nixos-test-driver-${name}";

    in

        lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName

    if lib.length invalidNodeNames > 0 then

      throw ''

        Cannot create machines out of (${lib.concatStringsSep ", " invalidNodeNames})!

        All machines are referenced as python variables in the testing framework which will break the

        script when special characters are used.

        Please stick to alphanumeric chars and underscores as separation.

      ''

    else lib.warnIf skipLint "Linting is disabled" (runCommand testDriverName

      {

        inherit testName;

        nativeBuildInputs = [ makeWrapper ];

        testScript = testScript';

        preferLocalBuild = true;

            testName = name;

        passthru = passthru // {

          inherit nodes;

        };
@@ -179,7 +165,7 @@ rec { 
        ${lib.optionalString (!skipLint) ''

          PYFLAKES_BUILTINS="$(

            echo -n ${lib.escapeShellArg (lib.concatStringsSep "," nodeHostNames)},

                < ${lib.escapeShellArg "${testDriver}/nix-support/driver-exports"}

            < ${lib.escapeShellArg "${testDriver}/nix-support/driver-symbols"}

          )" ${python3Packages.pyflakes}/bin/pyflakes $out/test-script

        ''}
@@ -187,47 +173,72 @@ rec { 
        vms=($(for i in ${toString vms}; do echo $i/bin/run-*-vm; done))

        wrapProgram $out/bin/nixos-test-driver \

          --add-flags "''${vms[*]}" \

              ${lib.optionalString enableOCR

                "--prefix PATH : '${ocrProg}/bin:${imagemagick_tiff}/bin'"} \

          --run "export testScript=\"\$(${coreutils}/bin/cat $out/test-script)\"" \

          --set VLANS '${toString vlans}'

        ln -s ${testDriver}/bin/nixos-test-driver $out/bin/nixos-run-vms

        wrapProgram $out/bin/nixos-run-vms \

          --add-flags "''${vms[*]}" \

              ${lib.optionalString enableOCR "--prefix PATH : '${ocrProg}/bin'"} \

          --set tests 'start_all(); join_all();' \

          --set VLANS '${toString vlans}'

          ''); # "

      '');



      passMeta = drv: drv // lib.optionalAttrs (t ? meta) {

        meta = (drv.meta or { }) // t.meta;

  # Make a full-blown test

  makeTest =

    { testScript

    , enableOCR ? false

    , name ? "unnamed"

      # Skip linting (mainly intended for faster dev cycles)

    , skipLint ? false

    , passthru ? {}

    , # For meta.position

      pos ? # position used in error messages and for meta.position

        (if t.meta.description or null != null

          then builtins.unsafeGetAttrPos "description" t.meta

          else builtins.unsafeGetAttrPos "testScript" t)

    , ...

    } @ t:

    let

      nodes = qemu_pkg:

        let

          build-vms = import ./build-vms.nix {

            inherit system pkgs minimal specialArgs;

            extraConfigurations = extraConfigurations ++ [(

              {

                virtualisation.qemu.package = qemu_pkg;

                # Ensure we do not use aliases. Ideally this is only set

                # when the test framework is used by Nixpkgs NixOS tests.

                nixpkgs.config.allowAliases = false;

              }

            )];

          };

        in

          build-vms.buildVirtualNetwork (

              t.nodes or (if t ? machine then { machine = t.machine; } else { })

          );



      driver = mkDriver null;

      driverInteractive = mkDriver pkgs.qemu;



      test = passMeta (runTests { inherit driver pos; });



      nodeNames = builtins.attrNames driver.nodes;

      invalidNodeNames = lib.filter

        (node: builtins.match "^[A-z_]([A-z0-9_]+)?$" node == null)

        nodeNames;

      driver = setupDriverForTest {

        inherit testScript enableOCR skipLint;

        testName = name;

        qemu_pkg = pkgs.qemu_test;

        nodes = nodes pkgs.qemu_test;

      };

      driverInteractive = setupDriverForTest {

        inherit testScript enableOCR skipLint;

        testName = name;

        qemu_pkg = pkgs.qemu;

        nodes = nodes pkgs.qemu;

      };



      nodeHostNames = map (c: c.config.system.name) (lib.attrValues driver.nodes);

      test =

        let

          passMeta = drv: drv // lib.optionalAttrs (t ? meta) {

            meta = (drv.meta or { }) // t.meta;

          };

        in passMeta (runTests { inherit driver pos; });



    in

    if lib.length invalidNodeNames > 0 then

      throw ''

        Cannot create machines out of (${lib.concatStringsSep ", " invalidNodeNames})!

        All machines are referenced as python variables in the testing framework which will break the

        script when special characters are used.



        Please stick to alphanumeric chars and underscores as separation.

      ''

    else

      test // {

        inherit test driver driverInteractive;

        inherit (driver) nodes;

        inherit test driver driverInteractive nodes;

      };



  runInMachine =
@@ -235,7 +246,7 @@ rec { 
    , machine

    , preBuild ? ""

    , postBuild ? ""

    , qemu ? pkgs.qemu_test

    , qemu_pkg ? pkgs.qemu_test

    , ... # ???

    }:

    let
@@ -272,6 +283,8 @@ rec { 
        client.succeed("sync") # flush all data before pulling the plug

      '';



      testDriver = pythonTestDriver { inherit qemu_pkg; };



      vmRunCommand = writeText "vm-run" ''

        xchg=vm-state-client/xchg

        ${coreutils}/bin/mkdir $out
@@ -290,7 +303,7 @@ rec { 
        unset xchg



        export tests='${testScript}'

        ${mkTestDriver qemu}/bin/nixos-test-driver --keep-vm-state ${vm.config.system.build.vm}/bin/run-*-vm

        ${testDriver}/bin/nixos-test-driver --keep-vm-state ${vm.config.system.build.vm}/bin/run-*-vm

      ''; # */



    in