Merge pull request #101 from seibert-media/remove-imports

Remove imports

Author: jpaul-seibert

CHANGELOG.md

@@ -3,6 +3,7 @@
 # 3.0.0
 - Removed deprecated syntax and features:
   - `a_vars`
+  - "imports" feature (replaced with precommands)
 
 # 2.13.0
 - Using "imports" is now deprecated

README.md

@@ -71,19 +71,13 @@ All (string) configuration values can be overwritten by the
 
     # Encoding
     encoding: 'utf-8'
-    
-    # Path for shell imports
-    import_path: '.'
 
     # Path to local bash (default: /bin/bash)
     bash_path: '/bin/bash'
 
     # SSH Command used for remote connections
     ssh_cmd: 'ssh {hostname} sudo '
 
-    # Temporary directory on remote machines for shell imports
-    remote_tmp_dir: 'automatix_tmp'
-    
     # Logger
     logger: 'mylogger'
 
@@ -299,13 +293,6 @@ You can refer to these systems in the command pipeline in multiple ways:
  The resolved secret values are accessible in command line via
  {secretname}. *(only if teamvault is enabled)*
 
-**imports** _(list)_, deprecated
-: Listed shell files (see **CONFIGURATION** section, _import_path_)
- will be sourced before every local or remote command execution.
- For remote commands, these files are transferred via tar and ssh to
- your home directory on the remote system beforehand and deleted
- afterwards. This is meant to define some functions you may need.
-
 **precommands** _(associative array)_
 : Define a command which is executed before every shell command.
  You can specify a command for local and remote commands separately.
@@ -515,10 +502,9 @@ Do the same with variable content like URLs, to make it possible to
  parameters.
 
 Preferred way of using **automatix** is to put often used and complex
- algorithms in shell functions or python libraries (shelllib/pylib)
- and import them. Advantage of this approach is that you can use your
- implemented functions multiple times and build up a toolbox of nice
- functionality over time.
+ algorithms in python libraries and import them. Advantage of this
+ approach is that you can use your  implemented functions multiple
+ times and build up a toolbox of nice functionality over time.
 
 
 # NOTES

automatix/command.py

@@ -406,18 +406,16 @@ def _python_action(self) -> int:
             return 1
 
     def _local_action(self) -> int:
-        cmd = self._build_command(path=self.env.config['import_path'])
+        cmd = self._build_command()
         try:
             return self._run_local_command(cmd=cmd)
         except KeyboardInterrupt:
             self.env.LOG.info(KEYBOARD_INTERRUPT_MESSAGE)
             return 130
 
-    def _build_command(self, path: str = '') -> str:
+    def _build_command(self) -> str:
         if self.precommand:
             return f'{self.precommand}; {self.get_resolved_value()}'
-        elif self.env.imports:
-            return f'. {path}/' + f'; . {path}/'.join(self.env.imports) + '; ' + self.get_resolved_value()
         else:
             return self.get_resolved_value()
 
@@ -458,28 +456,11 @@ def _remote_action_on_hostname(self, hostname: str) -> int:
             exitcode = 130
             self._remote_handle_keyboard_interrupt(hostname=hostname)
 
-        if self.env.imports:
-            self._remote_cleanup_imports(hostname=hostname)
-
         return exitcode
 
     def _get_remote_command(self, hostname: str) -> str:
         ssh_cmd = self.env.config["ssh_cmd"].format(hostname=hostname)
-        remote_cmd = self._build_command()
-        prefix = ''
-        if self.env.imports:
-            # How is this working?
-            # - Create a tar archive with all imports
-            # - Pipe it through SSH
-            # - Create tmp dir on remote
-            # - Extract tar archive there
-            # - Source imports in _build_command
-            prefix = f'tar -C {self.env.config["import_path"]} -cf - ' + ' '.join(self.env.imports) + ' | '
-            remote_cmd = f'mkdir {self.env.config["remote_tmp_dir"]};' \
-                         f' tar -C {self.env.config["remote_tmp_dir"]} -xf -;' \
-                         f' {self._build_command(path=self.env.config["remote_tmp_dir"])}'
-
-        return f'{prefix}{ssh_cmd}{quote("RUNNING_INSIDE_AUTOMATIX=1 bash -c " + quote(remote_cmd))}'
+        return f'{ssh_cmd}{quote("RUNNING_INSIDE_AUTOMATIX=1 bash -c " + quote(self._build_command()))}'
 
     def _remote_handle_keyboard_interrupt(self, hostname: str):
         ssh_cmd = self.env.config["ssh_cmd"].format(hostname=hostname)
@@ -537,19 +518,6 @@ def get_remote_pids(self, hostname) -> list:
 
         return pids
 
-    def _remote_cleanup_imports(self, hostname: str):
-        ssh_cmd = self.env.config["ssh_cmd"].format(hostname=hostname)
-        cleanup_cmd = f'{ssh_cmd} rm -r {self.env.config["remote_tmp_dir"]}'
-        self.env.LOG.debug(f'Executing: {cleanup_cmd}')
-        proc = subprocess.run(cleanup_cmd, shell=True, executable=self.bash_path)
-        if proc.returncode != 0:
-            self.env.LOG.warning(
-                'Failed to remove {tmp_dir}, exitcode: {return_code}'.format(
-                    tmp_dir=self.env.config["remote_tmp_dir"],
-                    return_code=proc.returncode,
-                )
-            )
-
 
 def parse_key(key) -> tuple[str, ...]:
     """

automatix/config.py

@@ -40,10 +40,8 @@
     'script_dir': '~/automatix-config',
     'constants': {},
     'encoding': 'utf-8',
-    'import_path': '.',
     'bash_path': '/bin/bash',
     'ssh_cmd': 'ssh {hostname} sudo ',
-    'remote_tmp_dir': 'automatix_tmp',
     'logger': 'automatix',
     'logfile_dir': 'automatix_logs',
     'bundlewrap': False,
@@ -307,7 +305,7 @@ def validate_script(script: dict):
     warn = 0
 
     if script.get('imports'):
-        LOG.warning('Using "imports" is deprecated. '
+        LOG.warning('The "imports" feature was removed in 3.0.0. '
                     'Please refactor your script or use the "precommands" feature instead.')
         warn += 1
 

automatix/environment.py

@@ -50,7 +50,6 @@ def __init__(
         self.name = script['name']
         self.script_file_path = script['_script_file_path']
         self.systems = script.get('systems', {})
-        self.imports = script.get('imports', [])
         self.batch_mode = script.get('_batch_mode', False)
         self.batch_items_count = script.get('_batch_items_count', 1)
 

example.automatix.cfg.yaml

@@ -10,18 +10,12 @@ constants:
 # Encoding
 encoding: 'utf-8'
 
-# Path to shell imports
-import_path: '.'
-
 # Path to local bash (default: /bin/bash)
 bash_path: '/bin/bash'
 
 # SSH Command used for remote connections
 ssh_cmd: 'ssh {hostname} sudo '
 
-# Temporary directory on remote machines for shell imports
-remote_tmp_dir: 'automatix_tmp'
-
 # Logger
 logger: 'mylogger'