···

       
130
       
130
       
 
       
start_all()

     

       
131
       
131
       
 
       
```

     

       
132
       
132
       
 
       


     

       
133
       
133
       
+
       
If the hostname of a node contains characters that can't be used in a

     

       
134
       
134
       
+
       
Python variable name, those characters will be replaced with

     

       
135
       
135
       
+
       
underscores in the variable name, so `nodes.machine-a` will be exposed

     

       
136
       
136
       
+
       
to Python as `machine_a`.

     

       
137
       
137
       
+
       


     

       
133
       
138
       
 
       
## Machine objects {#ssec-machine-objects}

     

       
134
       
139
       
 
       


     

       
135
       
140
       
 
       
The following methods are available on machine objects:

     

···

       
2
       
2
       
 
       
from pathlib import Path

     

       
3
       
3
       
 
       
from typing import Any, Dict, Iterator, List, Union, Optional, Callable, ContextManager

     

       
4
       
4
       
 
       
import os

     

       
5
       
5
       
+
       
import re

     

       
5
       
6
       
 
       
import tempfile

     

       
6
       
7
       
 
       


     

       
7
       
8
       
 
       
from test_driver.logger import rootlog

     
···

       
26
       
27
       
 
       
            f"The directory defined by TMPDIR, TEMP, TMP, or CWD: {tmp_dir} is not writeable"

     

       
27
       
28
       
 
       
        )

     

       
28
       
29
       
 
       
    return tmp_dir

     

       
30
       
30
       
+
       


     

       
31
       
31
       
+
       


     

       
32
       
32
       
+
       
def pythonize_name(name: str) -> str:

     

       
33
       
33
       
+
       
    return re.sub(r"^[^A-z_]|[^A-z0-9_]", "_", name)

     

       
29
       
34
       
 
       


     

       
30
       
35
       
 
       


     

       
31
       
36
       
 
       
class Driver:

     
···

       
113
       
118
       
 
       
            polling_condition=self.polling_condition,

     

       
114
       
119
       
 
       
            Machine=Machine,  # for typing

     

       
115
       
120
       
 
       
        )

     

       
116
       
116
       
-
       
        machine_symbols = {m.name: m for m in self.machines}

     

       
121
       
121
       
+
       
        machine_symbols = {pythonize_name(m.name): m for m in self.machines}

     

       
117
       
122
       
 
       
        # If there's exactly one machine, make it available under the name

     

       
118
       
123
       
 
       
        # "machine", even if it's not called that.

     

       
119
       
124
       
 
       
        if len(self.machines) == 1:

     

···

       
21
       
21
       
 
       
    in

     

       
22
       
22
       
 
       
    nodesList ++ lib.optional (lib.length nodesList == 1 && !lib.elem "machine" nodesList) "machine";

     

       
23
       
23
       
 
       


     

       
24
       
24
       
-
       
  # TODO: This is an implementation error and needs fixing

     

       
25
       
25
       
-
       
  # the testing famework cannot legitimately restrict hostnames further

     

       
26
       
26
       
-
       
  # beyond RFC1035

     

       
27
       
27
       
-
       
  invalidNodeNames = lib.filter

     

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

     

       
29
       
29
       
-
       
    nodeHostNames;

     

       
24
       
24
       
+
       
  pythonizeName = name:

     

       
25
       
25
       
+
       
    let

     

       
26
       
26
       
+
       
      head = lib.substring 0 1 name;

     

       
27
       
27
       
+
       
      tail = lib.substring 1 (-1) name;

     

       
28
       
28
       
+
       
    in

     

       
29
       
29
       
+
       
      (if builtins.match "[A-z_]" head == null then "_" else head) +

     

       
30
       
30
       
+
       
      lib.stringAsChars (c: if builtins.match "[A-z0-9_]" c == null then "_" else c) tail;

     

       
30
       
31
       
 
       


     

       
31
       
32
       
 
       
  uniqueVlans = lib.unique (builtins.concatLists vlans);

     

       
32
       
33
       
 
       
  vlanNames = map (i: "vlan${toString i}: VLan;") uniqueVlans;

     

       
33
       
33
       
-
       
  machineNames = map (name: "${name}: Machine;") nodeHostNames;

     

       
34
       
34
       
+
       
  pythonizedNames = map pythonizeName nodeHostNames;

     

       
35
       
35
       
+
       
  machineNames = map (name: "${name}: Machine;") pythonizedNames;

     

       
34
       
36
       
 
       


     

       
35
       
35
       
-
       
  withChecks =

     

       
36
       
36
       
-
       
    if lib.length invalidNodeNames > 0 then

     

       
37
       
37
       
-
       
      throw ''

     

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

     

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

     

       
40
       
40
       
-
       
        script when special characters are used.

     

       
41
       
41
       
-
       


     

       
42
       
42
       
-
       
        This is an IMPLEMENTATION ERROR and needs to be fixed. Meanwhile,

     

       
43
       
43
       
-
       
        please stick to alphanumeric chars and underscores as separation.

     

       
44
       
44
       
-
       
      ''

     

       
45
       
45
       
-
       
    else

     

       
46
       
46
       
-
       
      lib.warnIf config.skipLint "Linting is disabled";

     

       
37
       
37
       
+
       
  withChecks = lib.warnIf config.skipLint "Linting is disabled";

     

       
47
       
38
       
 
       


     

       
48
       
39
       
 
       
  driver =

     

       
49
       
40
       
 
       
    hostPkgs.runCommand "nixos-test-driver-${config.name}"

     
···

       
87
       
78
       
 
       
        ${testDriver}/bin/generate-driver-symbols

     

       
88
       
79
       
 
       
        ${lib.optionalString (!config.skipLint) ''

     

       
89
       
80
       
 
       
          PYFLAKES_BUILTINS="$(

     

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

     

       
81
       
81
       
+
       
            echo -n ${lib.escapeShellArg (lib.concatStringsSep "," pythonizedNames)},

     

       
91
       
82
       
 
       
            < ${lib.escapeShellArg "driver-symbols"}

     

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

     

       
93
       
84
       
 
       
        ''}