kheops/albero/plugin/common.py

# from box import Box
import textwrap
from pprint import pprint
import glob
from pathlib import Path
from jinja2 import Template
import yaml
import json

import logging
log = logging.getLogger(__name__)

from albero.utils import schema_validate
import copy

# Candidate Classes
# =============================
class Candidate():    
    engine = None    
    found = False    
    data = None    
    run = None
    scope = None
    key = None

    def __init__(self, run):
        self.run = copy.deepcopy(run)

    def __repr__(self):    
        return f"{self.__dict__}"    
                
    def _report_data(self, data=None):
        default_data = {
                #"rule": self.config,
                    "value": self.engine._plugin_value,
                    "data": self.data,
                    }
        data = data or default_data
        d = json.dumps(data, indent=2) #, sort_keys=True, )
        return d






# Generic Classes
# =============================
class PluginClass():
    _plugin_type = "none"
    _plugin_value = None

    _schema_props_new = "UNSET PLUGIN PROPRIETIES"

    _schema_props_plugin = {
            "engine": {
                    "type": "string",
                    # TODO: Fix this ug
                    "default": "jerakia"
                    },
            "value": {},
            }

    def __repr__(self):
        kind = self._plugin_type
        name = self._plugin_name
        value = getattr(self, 'value', 'NO VALUE')
        return f"{kind}.{name}:{value}"

    def __init__(self, config=None, parent=None, app=None):
        # assert (isinstance(config, dict)), f"Got: {config}"
        self.parent = parent
        self.app = app
        self.config = config or {}

        self._init()
        self._validate()

    def _init(self):
        pass
    def _validate(self):
        pass

class PluginBackendClass(PluginClass):
    _plugin_type = "backend"

    def _init(self):
        pass

class PluginStrategyClass(PluginClass):
    _plugin_type = "strategy"

    def _init(self):
        pass

class PluginEngineClass(PluginClass):
    _plugin_type = "engine"

    _schema_props_default = {
            "value": {
                "default": "UNSET",
                },

            #### SHOULD NOT BE HERE
            "hier": {
                "additionalProperties": True,
                "optional": True,
                "properties": {
                    "var": {
                        "type": "string",
                        "default": "item",
                        "optional": True,
                        },
                    "data": {
                        "default": None,
                        "anyOf": [
                            { "type": "null" },
                            { "type": "string" },
                            { "type": "array" },
                            ]
                        },
                    "separator": {
                        "type": "string",
                        "default": "/",
                        "optional": True,
                        },
                    "reversed": {
                        "type": "boolean",
                        "default": False,
                        "optional": True,
                    },
                }
            }
        }


    # Default plugin API Methods
    # =====================
    def _init(self):
        assert isinstance(self.config, dict), f"Got: {self.config}"

    def _validate(self):

        # Build schema
        schema_keys = [a for a in dir(self) if a.startswith('_schema_props_')]
        props = {}
        for key in schema_keys:
            schema = getattr(self, key)
            props.update(schema)
        self.schema = {
            "$schema": 'http://json-schema.org/draft-04/schema#',
            "type": "object",
            "additionalProperties": True,
            "properties": props,
        }

        # log.debug (f"Validate {self.config} against {self.schema}")
        self.config = schema_validate(self.config, self.schema)
        return True


    # Public Methods
    # =====================
    def dump(self):
        ret = {
            "config": self.config,
                }
        return ret

    def lookup_candidates(self, key=None, scope=None):
        raise Exception (f"Module does not implement this method :(")
        # It must always return a list of `Candidate` instances
        return []

    def _example(self):
        print (f"Module does not implement this method :(")
        return None


# File plugins Extensions
# =============================

class PluginFileGlob():

    _schema_props_glob = {
            "glob": {
                "additionalProperties": False,
                "default": {
                        "file": "ansible.yaml",
                    },
                "properties": {
                    "file": {
                        "type": "string",
                        "default": "ansible",
                        "optional": True,
                        },
                    "ext": {
                        "type": "array",
                        "default": [ "yml", "yaml" ],
                        "optional": True,
                    },
                }
            }
        }

    def _glob(self, item):
        
        # DIRECT CALL TO APP< TOFIX
        app_config = self.app.conf2
        root = app_config.get("default", {}).get("config", {}).get("root", f"{Path.cwd()}/tree")
        #root = self.app.conf2.config.app.root
        # TOFIX print ("ITEM! %s" % type(root))
        # TOFIX print ("ITEM2 %s" % self.app.conf2.config.app.root)

        glob_config = self.config.get("glob", {})
        glob_file = glob_config['file']
        #glob_ext = glob_config['ext']

        item = Path(root) / Path(item) / Path(glob_file)
        item = f"{item}"
        #file = f"{glob_file}.{glob_ext}"

        #print ("ITEM %s" % item)
        files = glob.glob(item)

        log.debug (f"Matched file for glob '{item}': {files}")

        return files