✨ document the new feature. moremoban/moban#217, #1

Author: chfw

docs/level-1-line-in-file/.moban.yml

@@ -0,0 +1,24 @@
+targets:
+  # remove a line from a file
+  - output: absent.txt
+    template: absent_file.txt
+    template_type:
+      base_type: lineinfile
+      options:
+        state: absent
+        regexp: "^remove.*$"
+  # ensure a line in a file
+  - output: ensure.txt
+    template: ensure_file.txt
+    template_type:
+      base_type: lineinfile
+      options:
+        regexp: "^code="
+        line: "code=C"
+  # append a line to a file
+  - output: append.txt
+    template: append_file.txt
+    template_type:
+      base_type: lineinfile
+      options:
+        line: "127.0.0.1 append"

docs/level-1-line-in-file/README.rst

@@ -0,0 +1,40 @@
+level 1 - lineinfile
+======================
+
+It has been requested to have line in file feature from ansible. So far, it supports three parameters.
+
+
+============ =================== =================================================================
+Parameter    Choices/Defaults    Comments
+============ =================== =================================================================
+state        'present', 'absent' Whether the line should be there or not.
+regrexp                          The regular expression to look for in every line of the file.
+line                             The line to insert/replace into the file.
+
+
+Here are currently supported features::
+
+    targets:
+      # remove a line from a file
+      - output: absent.txt
+        template: absent_file.txt
+        template_type:
+          base_type: lineinfile
+          options:
+            state: absent
+            regexp: "^remove.*$"
+      # ensure a line in a file
+      - output: ensure.txt
+        template: ensure_file.txt
+        template_type:
+          base_type: lineinfile
+          options:
+            regexp: "^code="
+            line: "code=C"
+      # append a line to a file
+      - output: append.txt
+        template: append_file.txt
+        template_type:
+          base_type: lineinfile
+          options:
+            line: "127.0.0.1 append"

docs/level-1-line-in-file/absent_file.txt

@@ -0,0 +1,2 @@
+remove me
+keep me

docs/level-1-line-in-file/append_file.txt

@@ -0,0 +1 @@
+192.168.0.1 abc

docs/level-1-line-in-file/ensure_file.txt

@@ -0,0 +1,3 @@
+[configuration]
+author=A
+code=B

moban_ansible/__init__.py

@@ -5,6 +5,7 @@
 ANSIBLE_LIBRARIES = "^moban_ansible_.+$"
 ANSIBLE_EXTENSIONS = [
     "moban_ansible.tests.files",
+    "moban_ansible.engines.line_in_file",
 ]
 
 

moban_ansible/engines/line_in_file.py

@@ -5,16 +5,16 @@
 
 @ContentProcessor("lineinfile", "Checking", "Checked")
 def line_in_file(content: str, options: dict) -> str:
+    content = content.decode()
     regexp = options.get("regexp")
-    create = options.get("create", False)
     state = options.get("state", "present")
 
     lines = content.split("\n")
 
     if state == "present":
         if regexp:
             lines = present(lines, options)
-        elif create:
+        else:
             # regexp is None or ''
             # append the line to the end
             line = options.get("line")
@@ -24,7 +24,8 @@ def line_in_file(content: str, options: dict) -> str:
     else:
         lines = list(absent(lines, options))
 
-    return "\n".join(lines)
+    content = "\n".join(lines)
+    return content.encode()
 
 
 def present(lines, options):

tests/__init__.py

@@ -0,0 +1,20 @@
+from .utils import Docs
+
+
+class TestRegression(Docs):
+    def setUp(self):
+        super(TestRegression, self).setUp()
+        self.base_folder = "docs"
+
+    def test_level_1(self):
+        ensure = "[configuration]\nauthor=A\ncode=C\n"
+        absent = "keep me\n"
+        append = "192.168.0.1 abc\n\n127.0.0.1 append"
+
+        folder = "level-1-line-in-file"
+        file_content_pairs = [
+            ("ensure.txt", ensure),
+            ("absent.txt", absent),
+            ("append.txt", append),
+        ]
+        self.run_moban(["moban"], folder, file_content_pairs)

tests/test_docs.py

@@ -6,33 +6,33 @@
 def test_append_a_line():
     options = {"create": "yes", "line": "192.168.1.1 foo.bar foo"}
 
-    content = "127.0.0.1 localhost"
+    content = b"127.0.0.1 localhost"
 
     new_content = line_in_file(content, options)
-    expected = [content, options["line"]]
+    expected = "\n".join([content.decode(), options["line"]])
 
-    eq_(new_content, "\n".join(expected))
+    eq_(new_content, expected.encode())
 
 
 def test_absent():
     absent_line = "192.168.1.1 foo.bar foo"
     options = {"regexp": ".*foo$", "state": "absent"}
 
-    content = f"127.0.0.1 localhost\n{absent_line}"
+    content = f"127.0.0.1 localhost\n{absent_line}".encode()
 
     new_content = line_in_file(content, options)
     expected = "127.0.0.1 localhost"
 
-    eq_(new_content, expected)
+    eq_(new_content, expected.encode())
 
 
 def test_present():
     present_line = "192.168.1.1 foo.bar foo"
     options = {"regexp": ".*foo$", "line": present_line}
 
-    content = f"127.0.0.1 localhost\n192.162.1.1 foo"
+    content = b"127.0.0.1 localhost\n192.162.1.1 foo"
 
     new_content = line_in_file(content, options)
     expected = ["127.0.0.1 localhost", present_line]
 
-    eq_(new_content, "\n".join(expected))
+    eq_(new_content, "\n".join(expected).encode())