Added more unit test coverage

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

Author: jakub-nt

cfbs/utils.py

@@ -5,7 +5,6 @@
 import copy
 import subprocess
 import hashlib
-import logging as log
 from typing import List, Tuple
 import urllib
 import urllib.request  # needed on some platforms
@@ -79,12 +78,12 @@ def cp(src, dst):
     sh("rsync -r %s/ %s" % (src, dst))
 
 
-def pad_left(s, n) -> int:
-    return s if len(s) >= n else " " * (n - len(s)) + s
+def pad_left(s, n):
+    return s.rjust(n)
 
 
-def pad_right(s, n) -> int:
-    return s if len(s) >= n else s + " " * (n - len(s))
+def pad_right(s, n):
+    return s.ljust(n)
 
 
 def split_command(command) -> Tuple[str, List[str]]:
@@ -137,12 +136,14 @@ def item_index(iterable, item, extra_at_end=True):
 
 
 def strip_right(string, ending):
+    # can be replaced with str.removesuffix from Python 3.9 onwards
     if not string.endswith(ending):
         return string
     return string[0 : -len(ending)]
 
 
 def strip_left(string, beginning):
+    # can be replaced with str.removeprefix from Python 3.9 onwards
     if not string.startswith(beginning):
         return string
     return string[len(beginning) :]
@@ -163,7 +164,7 @@ def save_file(path, data):
         f.write(data)
 
 
-def read_json(path):
+def read_json(path) -> OrderedDict:
     try:
         with open(path, "r") as f:
             return json.loads(f.read(), object_pairs_hook=OrderedDict)
@@ -280,7 +281,6 @@ def immediate_files(path):
 
 
 def path_append(dir, subdir):
-    dir = os.path.abspath(os.path.expanduser(dir))
     return dir if not subdir else os.path.join(dir, subdir)
 
 
@@ -296,7 +296,10 @@ def are_paths_equal(path_a, path_b) -> bool:
 
 
 def cfengine_dir(subdir=None):
-    return path_append("~/.cfengine/", subdir)
+    CFENGINE_DIR = "~/.cfengine/"
+    cfengine_dir_abspath = os.path.abspath(os.path.expanduser(CFENGINE_DIR))
+
+    return path_append(cfengine_dir_abspath, subdir)
 
 
 def cfbs_dir(append=None) -> str:

tests/sample/sample_dir/sample_file_1.txt

@@ -0,0 +1,7 @@
+{
+  "a": 1,
+  "b": {
+    "c": "value",
+    "d": [2, "string"]
+  }
+}

tests/sample/sample_dir/sample_file_2.txt

@@ -1,14 +1,50 @@
+from collections import OrderedDict
 from cfbs.utils import (
     canonify,
     deduplicate_def_json,
+    deduplicate_list,
     dict_diff,
+    dict_sorted_by_key,
     file_sha256,
+    immediate_files,
+    immediate_subdirectories,
+    is_a_commit_hash,
     merge_json,
     loads_bundlenames,
+    pad_left,
+    pad_right,
+    path_append,
+    read_json,
     string_sha256,
 )
 
 
+def test_pad_left():
+    s = "module_name"
+    n = 20
+
+    assert pad_left(s, n) == "         module_name"
+
+
+def test_pad_right():
+    s = "module_name"
+    n = 20
+
+    assert pad_right(s, n) == "module_name         "
+
+
+def test_read_json():
+    json_path = "tests/sample/sample_json.json"
+    expected_dict = OrderedDict(
+        [("a", 1), ("b", OrderedDict([("c", "value"), ("d", [2, "string"])]))]
+    )
+
+    assert read_json(json_path) == expected_dict
+
+    assert read_json("tests/thisfiledoesntexist.json") is None
+    assert read_json("tests/thisdirdoesntexist/file.json") is None
+
+
 def test_merge_json():
     original = {"classes": {"services_autorun": ["any"]}}
     extras = {
@@ -142,13 +178,48 @@ def test_deduplicate_def_json():
     assert deduplicated == expected
 
 
+def test_deduplicate_list():
+    l = [1, 2, 3, 3, 1, 4]
+
+    assert deduplicate_list(l) == [1, 2, 3, 4]
+
+
+def test_dict_sorted_by_key():
+    d = {"b": 1, "c": 3, "a": 2}
+
+    expected_dict = OrderedDict([("a", 2), ("b", 1), ("c", 3)])
+
+    assert dict_sorted_by_key(d) == expected_dict
+
+
 def test_dict_diff():
     A = {"A": "a", "B": "b", "C": "c"}
     B = {"A": "a", "B": "c", "D": "d"}
 
     assert dict_diff(A, B) == (["C"], ["D"], [("B", "b", "c")])
 
 
+def test_immediate_subdirectories():
+    path = "tests/sample/sample_dir"
+    expected = ["sample_subdir_A", "sample_subdir_B"]
+
+    assert immediate_subdirectories(path) == expected
+
+
+def test_immediate_files():
+    path = "tests/sample/sample_dir"
+    expected = ["sample_file_1.txt", "sample_file_2.txt"]
+
+    assert immediate_files(path) == expected
+
+
+def test_path_append():
+    path = "tests/sample/sample_dir"
+
+    assert path_append(path, "abc") == "tests/sample/sample_dir/abc"
+    assert path_append(path, None) == path
+
+
 def test_string_sha256():
     s = "cfbs/masterfiles/"
     checksum = "9e63d3266f80328fb6547b3462e81ab55b13f689d6b0944e242e2b3a0f3a32a3"
@@ -163,6 +234,15 @@ def test_file_sha256():
     assert file_sha256(file_path) == checksum
 
 
+def test_is_a_commit_hash():
+    assert is_a_commit_hash("304d123ac7ff50714a1eb57077acf159f923c941") == True
+    sha256_hash = "98142d6fa7e2e5f0942b0a215c1c4b976e7ae2ee5edb61cef974f1ba6756cbbc"
+    assert is_a_commit_hash(sha256_hash) == True
+    # at least currently, commit cannot be a shortened hash
+    assert is_a_commit_hash("4738c43") == False
+    assert is_a_commit_hash("") == False
+
+
 def test_canonify():
     assert canonify("Hello CFEngine!") == "Hello_CFEngine_"
     assert canonify("/etc/os-release") == "_etc_os_release"