First stable release almost ready

.gitignore

@@ -96,8 +96,4 @@ tags
 .vars
 output/
 
-demo/log
-
-tests.log
-
 .DS_Store

brigade/core/__init__.py

@@ -72,6 +72,7 @@ def __init__(self, inventory, dry_run, config=None, config_file=None,
         logging.basicConfig(
             level=logging.ERROR,
             format=format,
+            filename="brigade.log",
         )
         if available_connections is not None:
             self.available_connections = available_connections
@@ -89,25 +90,25 @@ def filter(self, **kwargs):
         b.inventory = self.inventory.filter(**kwargs)
         return b
 
-    def _run_serial(self, task, **kwargs):
+    def _run_serial(self, task, dry_run, **kwargs):
         t = Task(task, **kwargs)
         result = AggregatedResult()
         for host in self.inventory.hosts.values():
             try:
                 logger.debug("{}: running task {}".format(host.name, t))
-                r = t._start(host=host, brigade=self, dry_run=self.dry_run)
+                r = t._start(host=host, brigade=self, dry_run=dry_run)
                 result[host.name] = r
             except Exception as e:
                 logger.error("{}: {}".format(host, e))
                 result.failed_hosts[host.name] = e
                 result.tracebacks[host.name] = traceback.format_exc()
         return result
 
-    def _run_parallel(self, task, num_workers, **kwargs):
+    def _run_parallel(self, task, num_workers, dry_run, **kwargs):
         result = AggregatedResult()
 
         pool = Pool(processes=num_workers)
-        result_pool = [pool.apply_async(run_task, args=(h, self, Task(task, **kwargs)))
+        result_pool = [pool.apply_async(run_task, args=(h, self, dry_run, Task(task, **kwargs)))
                        for h in self.inventory.hosts.values()]
         pool.close()
         pool.join()
@@ -121,14 +122,15 @@ def _run_parallel(self, task, num_workers, **kwargs):
                 result[host] = res
         return result
 
-    def run(self, task, num_workers=None, **kwargs):
+    def run(self, task, num_workers=None, dry_run=None, **kwargs):
         """
         Run task over all the hosts in the inventory.
 
         Arguments:
             task (``callable``): function or callable that will be run against each device in
               the inventory
             num_workers(``int``): Override for how many hosts to run in paralell for this task
+            dry_run(``bool``): Whether if we are testing the changes or not
             **kwargs: additional argument to pass to ``task`` when calling it
 
         Raises:
@@ -141,19 +143,19 @@ def run(self, task, num_workers=None, **kwargs):
         num_workers = num_workers or self.config.num_workers
 
         if num_workers == 1:
-            result = self._run_serial(task, **kwargs)
+            result = self._run_serial(task, dry_run, **kwargs)
         else:
-            result = self._run_parallel(task, num_workers, **kwargs)
+            result = self._run_parallel(task, num_workers, dry_run, **kwargs)
 
         if self.config.raise_on_error:
             result.raise_on_error()
         return result
 
 
-def run_task(host, brigade, task):
+def run_task(host, brigade, dry_run, task):
     try:
         logger.debug("{}: running task {}".format(host.name, task))
-        r = task._start(host=host, brigade=brigade, dry_run=brigade.dry_run)
+        r = task._start(host=host, brigade=brigade, dry_run=dry_run)
         return host.name, r, None, None
     except Exception as e:
         logger.error("{}: {}".format(host, e))

brigade/core/task.py

@@ -35,7 +35,7 @@ def __repr__(self):
     def _start(self, host, brigade, dry_run):
         self.host = host
         self.brigade = brigade
-        self.dry_run = dry_run
+        self.dry_run = dry_run if dry_run is not None else brigade.dry_run
         return self.task(self, **self.params)
 
     def run(self, task, **kwargs):

brigade/plugins/tasks/files/__init__.py

@@ -1,6 +1,8 @@
 from .sftp import sftp
+from .write import write
 
 
 __all__ = (
     "sftp",
+    "write",
 )

brigade/plugins/tasks/files/write.py

@@ -0,0 +1,48 @@
+import difflib
+import os
+
+from brigade.core.task import Result
+
+
+def read_file(file):
+    if not os.path.exists(file):
+        return []
+    with open(file, "r") as f:
+        return f.read().splitlines()
+
+
+def generate_diff(filename, content, append):
+    original = read_file(filename)
+    if append:
+        c = list(original)
+        c.extend(content.splitlines())
+        content = c
+    else:
+        content = content.splitlines()
+
+    diff = difflib.unified_diff(original, content, fromfile=filename, tofile="new")
+
+    return "\n".join(diff)
+
+
+def write(task, filename, content, append=False):
+    """
+    Write contents to a file (locally)
+
+    Arguments:
+        filename (``str``): file you want to write into
+        conteint (``str``): content you want to write
+        append (``bool``): whether you want to replace the contents or append to it
+
+    Returns:
+        * changed (``bool``):
+        * diff (``str``): unified diff
+    """
+    diff = generate_diff(filename, content, append)
+
+    if not task.dry_run:
+        mode = "a+" if append else "w+"
+        with open(filename, mode=mode) as f:
+            f.write(content)
+
+    return Result(host=task.host, diff=diff, changed=bool(diff))

tests/plugins/tasks/files/test_sftp.py

@@ -9,8 +9,8 @@
 class Test(object):
 
     def test_sftp_put(self, brigade):
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="put",
                              src="README.md",
                              dst="/tmp/README.md")
@@ -19,8 +19,8 @@ def test_sftp_put(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = False
         result = brigade.run(files.sftp,
+                             dry_run=False,
                              action="put",
                              src="README.md",
                              dst="/tmp/README.md")
@@ -29,8 +29,8 @@ def test_sftp_put(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="put",
                              src="README.md",
                              dst="/tmp/README.md")
@@ -41,8 +41,8 @@ def test_sftp_put(self, brigade):
 
     def test_sftp_get(self, brigade):
         filename = "/tmp/" + str(uuid.uuid4()) + "-{host}"
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="get",
                              src="/etc/hostname",
                              dst=filename)
@@ -51,8 +51,8 @@ def test_sftp_get(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = False
         result = brigade.run(files.sftp,
+                             dry_run=False,
                              action="get",
                              src="/etc/hostname",
                              dst=filename)
@@ -61,8 +61,8 @@ def test_sftp_get(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=False,
                              action="get",
                              src="/etc/hostname",
                              dst=filename)
@@ -72,8 +72,8 @@ def test_sftp_get(self, brigade):
             assert not r.changed
 
     def test_sftp_put_directory(self, brigade):
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="put",
                              src="./brigade",
                              dst="/tmp/asd")
@@ -82,8 +82,8 @@ def test_sftp_put_directory(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = False
         result = brigade.run(files.sftp,
+                             dry_run=False,
                              action="put",
                              src="./brigade",
                              dst="/tmp/asd")
@@ -92,8 +92,8 @@ def test_sftp_put_directory(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="put",
                              src="./brigade",
                              dst="/tmp/asd")
@@ -104,8 +104,8 @@ def test_sftp_put_directory(self, brigade):
 
     def test_sftp_get_directory(self, brigade):
         filename = "/tmp/" + str(uuid.uuid4()) + "-{host}"
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="get",
                              src="/etc/terminfo/",
                              dst=filename)
@@ -114,8 +114,8 @@ def test_sftp_get_directory(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = False
         result = brigade.run(files.sftp,
+                             dry_run=False,
                              action="get",
                              src="/etc/terminfo/",
                              dst=filename)
@@ -124,8 +124,8 @@ def test_sftp_get_directory(self, brigade):
         for h, r in result.items():
             assert r.changed, r.files_changed
 
-        brigade.dry_run = True
         result = brigade.run(files.sftp,
+                             dry_run=True,
                              action="get",
                              src="/etc/terminfo/",
                              dst=filename)