Moved and renamed a function and clarified documentation related to build step splitting

Signed-off-by: jakub-nt <175944085+jakub-nt@users.noreply.github.com>

Author: jakub-nt

JSON.md

@@ -222,7 +222,7 @@ These are copies of the module directories, where it's more "safe" to do things
 ## All available build steps
 
 The build steps below manipulate the temporary files in the steps directories and write results to the output policy set, in `out/masterfiles`.
-Unless otherwise noted, all steps are run inside the module's folder (`out/steps/...`) with sources / file paths relative to that folder, and targets / destinations mentioned below are relative to the output policy set (`out/masterfiles`, which in the end will be deployed as `/var/cfengine/masterfiles`).
+Unless otherwise noted, all steps are run inside the module's folder (`out/steps/...`) with sources / file paths relative to that folder, and targets / destinations mentioned below are relative to the output policy set (`out/masterfiles`, which in the end will be deployed as `/var/cfengine/masterfiles`). In `cfbs.json`'s `"steps"`, the build step name must be separated from the rest of the build step by a regular space.
 
 * `copy <source> <destination>`
   * Copy a single file or a directory recursively.

cfbs/build.py

@@ -1,5 +1,6 @@
 import os
 import logging as log
+from typing import List, Tuple
 from cfbs.utils import (
     canonify,
     cp,
@@ -12,7 +13,6 @@
     read_json,
     rm,
     sh,
-    split_command,
     strip_left,
     touch,
     user_error,
@@ -73,8 +73,14 @@ def _generate_augment(module_name, input_data):
     return augment
 
 
+def split_build_step(command) -> Tuple[str, List[str]]:
+    terms = command.split(" ")
+    operation, args = terms[0], terms[1:]
+    return operation, args
+
+
 def _perform_build_step(module, step, max_length):
-    operation, args = split_command(step)
+    operation, args = split_build_step(step)
     source = module["_directory"]
     counter = module["_counter"]
     destination = "out/masterfiles"
@@ -245,7 +251,7 @@ def perform_build_steps(config) -> int:
     # mini-validation
     for module in config.get("build", []):
         for step in module["steps"]:
-            operation, args = split_command(step)
+            operation, args = split_build_step(step)
 
             if step.split() != [operation] + args:
                 user_error(

cfbs/utils.py

@@ -5,7 +5,6 @@
 import copy
 import subprocess
 import hashlib
-from typing import List, Tuple
 import urllib
 import urllib.request  # needed on some platforms
 from collections import OrderedDict
@@ -86,12 +85,6 @@ def pad_right(s, n):
     return s.ljust(n)
 
 
-def split_command(command) -> Tuple[str, List[str]]:
-    terms = command.split(" ")
-    operation, args = terms[0], terms[1:]
-    return operation, args
-
-
 def is_valid_arg_count(args, expected):
     actual = len(args)
 
@@ -173,7 +166,7 @@ def read_json(path) -> OrderedDict:
     except NotADirectoryError:
         return None
     except json.decoder.JSONDecodeError as ex:
-        print("Error reading json file {} : {}".format(path, ex))
+        print("Error reading json file '{}': {}".format(path, ex))
         sys.exit(1)
 
 

cfbs/validate.py

@@ -1,13 +1,16 @@
 import argparse
-import json
 import sys
 import re
 from collections import OrderedDict
 
-from cfbs.utils import is_valid_arg_count, is_a_commit_hash, split_command, user_error
+from cfbs.utils import (
+    is_valid_arg_count,
+    is_a_commit_hash,
+    user_error,
+)
 from cfbs.pretty import TOP_LEVEL_KEYS, MODULE_KEYS
 from cfbs.cfbs_config import CFBSConfig
-from cfbs.build import AVAILABLE_BUILD_STEPS
+from cfbs.build import AVAILABLE_BUILD_STEPS, split_build_step
 
 
 class CFBSValidationError(Exception):
@@ -266,7 +269,7 @@ def validate_steps(name, module):
                 raise CFBSValidationError(
                     name, '"steps" must be a list of non-empty / non-whitespace strings'
                 )
-            operation, args = split_command(step)
+            operation, args = split_build_step(step)
             if not operation in AVAILABLE_BUILD_STEPS:
                 x = ", ".join(AVAILABLE_BUILD_STEPS)
                 raise CFBSValidationError(