feat: skip selected hosts with new _meta option

Author: pythoninja

examples/hosts.yml

@@ -7,15 +7,27 @@ group1: # host_group
         _auth_type: IdentityAgent
         _auth_path: ~/.1password/agent.sock
         _aliases: [ "base", "another-alias" ]
+        _skip: true
 
     host2:
       ansible_host: 127.0.0.2
       ansible_user: manager
       ansible_password:
+      _meta:
+        _skip: true
 
 group2:
   hosts:
-    another_host1:
+    host3:
       ansible_host: 172.19.0.1
       ansible_user: postgres
       ansible_password:
+
+    host4:
+        ansible_host: 172.99.99.99
+        ansible_user: postgres
+        _meta:
+          _auth_type: IdentityAgent
+          _auth_path: ~/.1password/agent.sock
+          _aliases: [ "base", "another-alias" ]
+          _skip: false

sshgen/generators/model.py

@@ -23,9 +23,10 @@ def convert(parsed_hosts: CommentedMap) -> list[HostModel]:
                 auth_type = meta.get('_auth_type')
                 auth_path = meta.get('_auth_path')
                 aliases = meta.get('_aliases')
+                skip = meta.get('_skip')
 
-                if any(isinstance(field, str | list) for field in (auth_type, auth_path, aliases)):
-                    model.meta_fields = MetaFieldsModel(auth_type, auth_path, aliases)
+                if any(isinstance(field, str | list | bool) for field in (auth_type, auth_path, aliases, skip)):
+                    model.meta_fields = MetaFieldsModel(auth_type, auth_path, aliases, skip)
 
                 host_models.append(model)
 

sshgen/generators/sshconfig.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python
+import copy
 from pathlib import Path
 
 from sshgen.logger import init_logger
@@ -10,15 +11,20 @@
 
 class SSHConfig:
     def __init__(self, models: list[HostModel], output_file: Path | None = None):
-        self.models = models
+        self.raw_models = models
         self.template_path = FileUtils.as_package_file('templates/ssh_config.template')
         self.ssh_template = self._open_template()
         self.output_file = output_file
 
     def generate(self) -> None:
-        configs: list[str] = [self._process(model) for model in self.models]
+        filtered_models: list[HostModel] = self._filter_models()
+        configs: list[str] = [self._process(m) for m in filtered_models]
         self._save_config(configs)
 
+    def _filter_models(self) -> list[HostModel]:
+        temp_models = copy.deepcopy(self.raw_models)
+        return [model for model in temp_models if not (model.meta_fields and model.meta_fields.skip)]
+
     def _process(self, model: HostModel) -> str:
         temp = self.ssh_template.replace('{{ host }}', model.host) \
             .replace('{{ hostname }}', model.ansible_host) \

sshgen/models/metafields.py

@@ -7,3 +7,4 @@ class MetaFieldsModel:
     auth_type: str | None = None
     auth_path: str | None = None
     aliases: list[str] | None = None
+    skip: bool | None = None