Darko Poljak
7 years ago
committed by
GitHub
parent
47399bfa9f
commit
a993e0f5a9
@ -0,0 +1,140 @@ |
||||
# -*- coding: utf-8 -*- |
||||
# |
||||
# 2018 Darko Poljak (darko.poljak at gmail.com) |
||||
# |
||||
# This file is part of cdist. |
||||
# |
||||
# cdist is free software: you can redistribute it and/or modify |
||||
# it under the terms of the GNU General Public License as published by |
||||
# the Free Software Foundation, either version 3 of the License, or |
||||
# (at your option) any later version. |
||||
# |
||||
# cdist is distributed in the hope that it will be useful, |
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
# GNU General Public License for more details. |
||||
# |
||||
# You should have received a copy of the GNU General Public License |
||||
# along with cdist. If not, see <http://www.gnu.org/licenses/>. |
||||
# |
||||
# |
||||
|
||||
import os |
||||
import shutil |
||||
|
||||
import cdist |
||||
from cdist import core |
||||
from cdist import test |
||||
from cdist.exec import local |
||||
from cdist.exec import remote |
||||
from cdist.core import code |
||||
from cdist.core import manifest |
||||
|
||||
import os.path as op |
||||
my_dir = op.abspath(op.dirname(__file__)) |
||||
fixtures = op.join(my_dir, 'fixtures') |
||||
conf_dir = op.join(fixtures, 'conf') |
||||
|
||||
|
||||
class CaptureOutputDisabledTestCase(test.CdistTestCase): |
||||
|
||||
def setUp(self): |
||||
# logging.root.setLevel(logging.TRACE) |
||||
save_output_streams = False |
||||
self.temp_dir = self.mkdtemp() |
||||
|
||||
self.local_dir = os.path.join(self.temp_dir, "local") |
||||
self.hostdir = cdist.str_hash(self.target_host[0]) |
||||
self.host_base_path = os.path.join(self.local_dir, self.hostdir) |
||||
os.makedirs(self.host_base_path) |
||||
self.local = local.Local( |
||||
target_host=self.target_host, |
||||
target_host_tags=None, |
||||
base_root_path=self.host_base_path, |
||||
host_dir_name=self.hostdir, |
||||
exec_path=cdist.test.cdist_exec_path, |
||||
add_conf_dirs=[conf_dir], |
||||
save_output_streams=save_output_streams) |
||||
self.local.create_files_dirs() |
||||
|
||||
self.remote_dir = self.mkdtemp() |
||||
remote_exec = self.remote_exec |
||||
remote_copy = self.remote_copy |
||||
self.remote = remote.Remote( |
||||
target_host=self.target_host, |
||||
remote_exec=remote_exec, |
||||
remote_copy=remote_copy, |
||||
base_path=self.remote_dir, |
||||
stdout_base_path=self.local.stdout_base_path, |
||||
stderr_base_path=self.local.stderr_base_path, |
||||
save_output_streams=save_output_streams) |
||||
self.remote.create_files_dirs() |
||||
|
||||
self.code = code.Code(self.target_host, self.local, self.remote) |
||||
|
||||
self.manifest = manifest.Manifest(self.target_host, self.local) |
||||
|
||||
self.cdist_type = core.CdistType(self.local.type_path, |
||||
'__write_to_stdout_and_stderr') |
||||
self.cdist_object = core.CdistObject(self.cdist_type, |
||||
self.local.object_path, |
||||
self.local.object_marker_name, |
||||
'') |
||||
self.cdist_object.create() |
||||
self.output_dirs = { |
||||
'object': { |
||||
'stdout': os.path.join(self.cdist_object.absolute_path, |
||||
'stdout'), |
||||
'stderr': os.path.join(self.cdist_object.absolute_path, |
||||
'stderr'), |
||||
}, |
||||
'init': { |
||||
'stdout': os.path.join(self.local.base_path, 'stdout'), |
||||
'stderr': os.path.join(self.local.base_path, 'stderr'), |
||||
}, |
||||
} |
||||
|
||||
def tearDown(self): |
||||
shutil.rmtree(self.local_dir) |
||||
shutil.rmtree(self.remote_dir) |
||||
shutil.rmtree(self.temp_dir) |
||||
|
||||
def _test_output(self, which, target, streams=('stdout', 'stderr')): |
||||
for stream in streams: |
||||
stream_path = os.path.join(self.output_dirs[target][stream], which) |
||||
if os.path.exists(stream_path): |
||||
with open(stream_path, 'r') as fd: |
||||
_is = fd.read() |
||||
self.assertEqual("", _is) |
||||
# else ok when not exists |
||||
|
||||
def test_capture_code_output_disabled(self): |
||||
self.cdist_object.code_local = self.code.run_gencode_local( |
||||
self.cdist_object) |
||||
self._test_output('gencode-local', 'object', ('stderr',)) |
||||
|
||||
self.code.run_code_local(self.cdist_object) |
||||
self._test_output('code-local', 'object') |
||||
|
||||
self.cdist_object.code_remote = self.code.run_gencode_remote( |
||||
self.cdist_object) |
||||
self._test_output('gencode-remote', 'object', ('stderr',)) |
||||
|
||||
self.code.transfer_code_remote(self.cdist_object) |
||||
self.code.run_code_remote(self.cdist_object) |
||||
self._test_output('code-remote', 'object') |
||||
|
||||
def test_capture_manifest_output_disabled(self): |
||||
self.manifest.run_type_manifest(self.cdist_object) |
||||
self._test_output('manifest', 'object') |
||||
|
||||
def test_capture_init_manifest_output_disabled(self): |
||||
initial_manifest = os.path.join(conf_dir, 'manifest', 'init') |
||||
self.manifest.run_initial_manifest(initial_manifest) |
||||
self._test_output('init', 'init') |
||||
|
||||
|
||||
if __name__ == "__main__": |
||||
import unittest |
||||
|
||||
unittest.main() |
||||
@ -0,0 +1,4 @@ |
||||
#!/bin/sh |
||||
|
||||
echo "init: stdout" |
||||
echo "init: stderr" >&2 |
||||
@ -0,0 +1,6 @@ |
||||
#!/bin/sh |
||||
|
||||
echo "gencode-local: stderr" >&2 |
||||
|
||||
echo "echo \"code-local: stdout\"" |
||||
echo "echo \"code-local: stderr\" >&2" |
||||
@ -0,0 +1,6 @@ |
||||
#!/bin/sh |
||||
|
||||
echo "gencode-remote: stderr" >&2 |
||||
|
||||
echo "echo \"code-remote: stdout\"" |
||||
echo "echo \"code-remote: stderr\" >&2" |
||||
@ -0,0 +1,4 @@ |
||||
#!/bin/sh |
||||
|
||||
echo "manifest: stdout" |
||||
echo "manifest: stderr" >&2 |
||||
@ -0,0 +1,88 @@ |
||||
Saving output streams |
||||
===================== |
||||
|
||||
Description |
||||
----------- |
||||
Since version 4.8.0 cdist, by default, saves output streams to local cache. |
||||
Saving output streams is implemented because important information was lost |
||||
during a config run, hidden in all other output. |
||||
Now all created output is bound to the context where it was produced. |
||||
|
||||
Saving output streams include stdout and stderr of init manifest, remote |
||||
commands and for each object stdout and stderr of manifest, gencode-* and code-*. |
||||
Output stream files are created only if some output is produced. For more info |
||||
on these cache files see `Local cache overview <cdist-cache.html>`_. |
||||
|
||||
Also, in case of an error, cdist can now exit and show all information it has |
||||
about the error. |
||||
|
||||
For example: |
||||
|
||||
.. code-block:: sh |
||||
|
||||
$ ./bin/cdist config -v -i ~/.cdist/manifest/init-output-streams $(cat ~/ungleich/data/opennebula-debian9-test ) |
||||
INFO: 185.203.112.42: Starting configuration run |
||||
INFO: 185.203.112.42: Processing __myline/test |
||||
ERROR: 185.203.112.42: Command failed: '/bin/sh -e /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw/code-local' |
||||
return code: 1 |
||||
---- BEGIN stdout ---- |
||||
---- END stdout ---- |
||||
|
||||
Error processing object '__myline/test' |
||||
======================================== |
||||
name: __myline/test |
||||
path: /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-kisrqlpw |
||||
source: /home/darko/.cdist/manifest/init-output-streams |
||||
type: /tmp/tmpow6cwemh/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline |
||||
|
||||
---- BEGIN manifest:stderr ---- |
||||
myline manifest stderr |
||||
|
||||
---- END manifest:stderr ---- |
||||
|
||||
---- BEGIN gencode-remote:stderr ---- |
||||
test gencode-remote error |
||||
|
||||
---- END gencode-remote:stderr ---- |
||||
|
||||
---- BEGIN code-local:stderr ---- |
||||
error |
||||
|
||||
---- END code-local:stderr ---- |
||||
|
||||
ERROR: cdist: Failed to configure the following hosts: 185.203.112.42 |
||||
|
||||
Upon successful run execution state is saved to local cache and temporary |
||||
directory is removed. |
||||
In case of an error temporary directory is not removed and can be further |
||||
discovered. |
||||
|
||||
There is also an option :strong:`-S/--disable-saving-output-streams` for |
||||
disabling saving output streams. In this case error reporting can look |
||||
like this: |
||||
|
||||
.. code-block:: sh |
||||
|
||||
$ ./bin/cdist config -v -S -i ~/.cdist/manifest/init-output-streams $(cat ~/ungleich/data/opennebula-debian9-test ) |
||||
INFO: 185.203.112.42: Starting configuration run |
||||
test stdout output streams |
||||
test stderr output streams |
||||
myline manifest stdout |
||||
myline manifest stderr |
||||
test gencode-remote error |
||||
INFO: 185.203.112.42: Processing __myline/test |
||||
error |
||||
ERROR: 185.203.112.42: Command failed: '/bin/sh -e /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-n566pqut/code-local' |
||||
return code: 1 |
||||
---- BEGIN stdout ---- |
||||
---- END stdout ---- |
||||
|
||||
Error processing object '__myline/test' |
||||
======================================== |
||||
name: __myline/test |
||||
path: /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/object/__myline/test/.cdist-n566pqut |
||||
source: /home/darko/.cdist/manifest/init-output-streams |
||||
type: /tmp/tmpzomy0wis/75ee6a79e32da093da23fe4a13dd104b/data/conf/type/__myline |
||||
|
||||
|
||||
ERROR: cdist: Failed to configure the following hosts: 185.203.112.42 |
||||
Loading…
Reference in new issue