commit 2a4d433b1f194595c819cec88361a1e402ebadb8 · pyrox.dev/nixpkgs

+5 -2

nixos/doc/manual/development/writing-nixos-tests.section.md

···

       162
       162
        
           If the command detaches, it must close stdout, as `execute` will wait

     

       163
       163
        
           for this to consume all output reliably. This can be achieved by

     

       164
       164
        
           redirecting stdout to stderr `>&2`, to `/dev/console`, `/dev/null` or

     

       165
       165
       -
           a file.

     

       165
       165
       +
           a file. Examples of detaching commands are `sleep 365d &`, where the

     

       166
       166
       +
           shell forks a new process that can write to stdout and `xclip -i`, where

     

       167
       167
       +
           the `xclip` command itself forks without closing stdout.

     

       166
       168
        
           Takes an optional parameter `check_return` that defaults to `True`.

     

       167
       169
        
           Setting this parameter to `False` will not check for the return code

     

       168
       170
        
           and return -1 instead. This can be used for commands that shut down

     
···

       183
       185
        
       

     

       184
       186
        
           -   Dereferencing unset variables fail the command.

     

       185
       187
        
       

     

       186
       186
       -
           -   It will wait for stdout to be closed. See `execute`.

     

       188
       188
       +
           -   It will wait for stdout to be closed. See `execute` for the

     

       189
       189
       +
               implications.

     

       187
       190
        
       

     

       188
       191
        
       `fail`

     

       189
       192

+8 -3

nixos/doc/manual/from_md/development/writing-nixos-tests.section.xml

···

       271
       271
        
                 for this to consume all output reliably. This can be achieved

     

       272
       272
        
                 by redirecting stdout to stderr <literal>&gt;&amp;2</literal>,

     

       273
       273
        
                 to <literal>/dev/console</literal>,

     

       274
       274
       -
                 <literal>/dev/null</literal> or a file. Takes an optional

     

       275
       275
       -
                 parameter <literal>check_return</literal> that defaults to

     

       274
       274
       +
                 <literal>/dev/null</literal> or a file. Examples of detaching

     

       275
       275
       +
                 commands are <literal>sleep 365d &amp;</literal>, where the

     

       276
       276
       +
                 shell forks a new process that can write to stdout and

     

       277
       277
       +
                 <literal>xclip -i</literal>, where the

     

       278
       278
       +
                 <literal>xclip</literal> command itself forks without closing

     

       279
       279
       +
                 stdout. Takes an optional parameter

     

       280
       280
       +
                 <literal>check_return</literal> that defaults to

     

       276
       281
        
                 <literal>True</literal>. Setting this parameter to

     

       277
       282
        
                 <literal>False</literal> will not check for the return code

     

       278
       283
        
                 and return -1 instead. This can be used for commands that shut

     
···

       314
       319
        
                 <listitem>

     

       315
       320
        
                   <para>

     

       316
       321
        
                     It will wait for stdout to be closed. See

     

       317
       317
       -
                     <literal>execute</literal>.

     

       322
       322
       +
                     <literal>execute</literal> for the implications.

     

       318
       323
        
                   </para>

     

       319
       324
        
                 </listitem>

     

       320
       325
        
               </itemizedlist>

+4 -3

nixos/doc/manual/from_md/release-notes/rl-2111.section.xml

···

       450
       450
        
               <para>

     

       451
       451
        
                 The NixOS VM test framework,

     

       452
       452
        
                 <literal>pkgs.nixosTest</literal>/<literal>make-test-python.nix</literal>,

     

       453
       453
       -
                 now requires non-terminating commands such as

     

       454
       454
       -
                 <literal>succeed(&quot;foo &amp;&quot;)</literal> to close

     

       455
       455
       -
                 stdout. This can be done with a redirect such as

     

       453
       453
       +
                 now requires detaching commands such as

     

       454
       454
       +
                 <literal>succeed(&quot;foo &amp;&quot;)</literal> and

     

       455
       455
       +
                 <literal>succeed(&quot;foo | xclip -i&quot;)</literal> to

     

       456
       456
       +
                 close stdout. This can be done with a redirect such as

     

       456
       457
        
                 <literal>succeed(&quot;foo &gt;&amp;2 &amp;&quot;)</literal>.

     

       457
       458
        
                 This breaking change was necessitated by a race condition

     

       458
       459
        
                 causing tests to fail or hang. It applies to all methods that

+1 -1

nixos/doc/manual/release-notes/rl-2111.section.md

···

       133
       133
        
       

     

       134
       134
        
       ## Backward Incompatibilities {#sec-release-21.11-incompatibilities}

     

       135
       135
        
       

     

       136
       136
       -
       - The NixOS VM test framework, `pkgs.nixosTest`/`make-test-python.nix`, now requires non-terminating commands such as `succeed("foo &")` to close stdout.

     

       136
       136
       +
       - The NixOS VM test framework, `pkgs.nixosTest`/`make-test-python.nix`, now requires detaching commands such as `succeed("foo &")` and `succeed("foo | xclip -i")` to close stdout.

     

       137
       137
        
         This can be done with a redirect such as `succeed("foo >&2 &")`. This breaking change was necessitated by a race condition causing tests to fail or hang.

     

       138
       138
        
         It applies to all methods that invoke commands on the nodes, including `execute`, `succeed`, `fail`, `wait_until_succeeds`, `wait_until_fails`.

     

       139
       139