Sardou 0.1.0__tar.gz

sardou-0.1.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: Sardou
+Version: 0.1.0
+Summary: Sardou TOSCA Library
+Author-email: Jay DesLauriers <j.deslauriers@westminster.ac.uk>
+Requires-Dist: ruamel.yaml

sardou-0.1.0/README.md

@@ -0,0 +1,91 @@
+# TOSCA in Swarmchestrate
+
+This repository is home to TOSCA in the [Swarmchestrate](https://www.swarmchestrate.eu/) project, which will use TOSCA v2.0 to describe applications and capacities managed in a Swarmchestrate Universe.
+
+
+## Sardou TOSCA Library
+
+Sardou validates and extracts info from a Swarmchestrate TOSCA template.
+
+### Prerequisites
+- Python 3.10+
+- [Puccini](https://github.com/tliron/puccini) 0.22.x
+  - Minimum GLIBC 2.34 (Ubuntu 22.04 or higher)
+  
+Install Puccini on Linux by:
+```sh
+wget https://github.com/tliron/puccini/releases/download/v0.22.7/puccini_0.22.7_linux_amd64.deb
+sudo dpkg -i puccini_0.22.7_linux_amd64.deb || sudo apt --fix-broken install -y
+rm -f puccini_0.22.7_linux_amd64.deb
+```
+
+### Installation
+
+Install using `pip` pointed at this GitHub repo. PyPI package coming soon.
+
+```bash
+pip install git+https://github.com/Swarmchestrate/tosca.git
+```
+
+### Usage
+
+Import the Sardou TOSCA Library
+
+```python
+from sardou import Sardou # note the uppercase F
+```
+
+Create a new `Sardou` object, passing it the path to your Swarmchestrate TOSCA template.
+This will validate the template. If there are errors or warnings, they will be presented here.
+
+```python
+>>> tosca = Sardou("my_app.yaml")
+Processed successfully: my_app.yaml 
+```
+
+Grab the QoS requirements as a Python object.
+You could wrap this as a dictionary and dump to JSON or YAML.
+
+```python
+>>> tosca.get_qos()
+[{'energy': {'type': 'swch:QoS.Energy.Budget', 'properties': {'priority': 0.3, 'target': 10}}}...
+```
+
+Grab the Resource requirements as a Python object.
+You could dump this to JSON or YAML.
+
+```python
+>>> tosca.get_requirements()
+{'worker-node': {'metadata': {'created_by': 'floria-tosca-lib', 'created_at': '2025-09-16T14:51:24Z', 'description': 'Generated from node worker-node', 'version': '1.0'}, 'capabilities': {'host': {'properties': {'num-cpus': {'$greater_than': 4}, 'mem-size': {'$greater_than': '8 GB'}}}, ...
+```
+
+You can traverse YAML maps using dot notation if needed.
+
+```python
+>>> tosca.service_template.node_templates
+{'swarm': {'type': 'swch:Swarm', 'directives': ['substitute']}, ...
+```
+
+## Devs
+
+It is recommended that developers open a GitHub Codespace on this repository, which includes dependencies and a Makefile for running Puccini manually.
+
+## TOSCA Template Validation with Puccini
+
+This is an added feature that provides a Python validation library and script to check whether TOSCA service templates are valid using the [Puccini](https://github.com/tliron/puccini) parser.
+
+##### Validation Library (`lib/validation.py `)
+- A library that defines the `validate_template()` function to validate a single TOSCA YAML file.
+- Returns `True` if the template is valid, `False` if not.
+
+##### Validation Script (`run_validation.py`)
+- A script that searches the `templates/` folder and validates all `.yaml` files in one run.
+- Prints total successes/failures and exits with code `1` if any file fails.
+  
+Run:
+- `python3 run_validation.py`
+
+
+## Contact
+
+Contact Jay at Westminster for support with TOSCA and/or this repository.

sardou-0.1.0/Sardou.egg-info/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: Sardou
+Version: 0.1.0
+Summary: Sardou TOSCA Library
+Author-email: Jay DesLauriers <j.deslauriers@westminster.ac.uk>
+Requires-Dist: ruamel.yaml

sardou-0.1.0/Sardou.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+Sardou.egg-info/PKG-INFO
+Sardou.egg-info/SOURCES.txt
+Sardou.egg-info/dependency_links.txt
+Sardou.egg-info/requires.txt
+Sardou.egg-info/top_level.txt
+sardou/__init__.py
+sardou/requirements.py
+sardou/sardou.py
+sardou/validation.py

sardou-0.1.0/Sardou.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sardou-0.1.0/Sardou.egg-info/requires.txt

@@ -0,0 +1 @@
+ruamel.yaml

sardou-0.1.0/Sardou.egg-info/top_level.txt

@@ -0,0 +1 @@
+sardou

sardou-0.1.0/pyproject.toml

@@ -0,0 +1,17 @@
+[project]
+name = "Sardou"
+version = "0.1.0"
+description = "Sardou TOSCA Library"
+authors = [
+    { name="Jay DesLauriers", email="j.deslauriers@westminster.ac.uk" }
+]
+dependencies = [
+    "ruamel.yaml"
+]
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["sardou"]

sardou-0.1.0/sardou/__init__.py

@@ -0,0 +1,2 @@
+from .sardou import Sardou
+

sardou-0.1.0/sardou/requirements.py

@@ -0,0 +1,75 @@
+"""
+TOSCA Resource Requirements Extractor
+Converts TOSCA node_filter data to ask.yaml format
+"""
+
+from datetime import datetime
+
+def convert_node_filter_to_capabilities(node_filter):
+    """Convert TOSCA node_filter to capabilities format"""
+    capabilities = {}
+    
+    # Extract conditions from $and
+    conditions = node_filter.get('$and', [])
+    
+    for condition in conditions:
+        for constraint_func, args in condition.items():
+            if len(args) >= 2:
+                # Parse the property path: [SELF, TARGET, CAPABILITY, capability_type, property_name]
+                property_path = args[0].get('$get_property', [])
+                if len(property_path) >= 5:
+                    capability_type = property_path[3]
+                    property_name = property_path[4]
+                    constraint_value = args[1]
+                    
+                    # Initialize capability structure
+                    if capability_type not in capabilities:
+                        capabilities[capability_type] = {'properties': {}}
+                    
+                    # Set the constraint
+                    if constraint_func == '$equal':
+                        capabilities[capability_type]['properties'][property_name] = constraint_value
+                    else:
+                        capabilities[capability_type]['properties'][property_name] = {constraint_func: constraint_value}
+    
+    return capabilities
+
+def extract_nodes_with_filter(tosca_dict):
+    """Extract nodes that have node_filter from node_templates"""
+    nodes_with_filter = {}
+    
+    node_templates = tosca_dict.get('service_template', {}).get('node_templates', {})
+    
+    for node_name, node_data in node_templates.items():
+        if 'node_filter' in node_data:
+            nodes_with_filter[node_name] = node_data['node_filter']
+                
+    return nodes_with_filter
+
+def tosca_to_ask_dict(tosca_dict):
+    """
+    Convert TOSCA dict to ask format dict
+    
+    Args:
+        tosca_dict (dict): Parsed TOSCA YAML data
+        
+    Returns:
+        dict: Ask format data
+    """
+    nodes_with_filter = extract_nodes_with_filter(tosca_dict)
+    ask_data = {}
+    
+    for node_name, node_filter in nodes_with_filter.items():
+        ask_entry = {
+            'metadata': {
+                'created_by': 'sardou-tosca-lib',
+                'created_at': datetime.now().strftime('%Y-%m-%dT%H:%M:%SZ'),
+                'description': f'Generated from node {node_name}',
+                'version': '1.0'
+            },
+            'capabilities': convert_node_filter_to_capabilities(node_filter)
+        }
+        
+        ask_data[node_name] = ask_entry
+    
+    return ask_data

sardou-0.1.0/sardou/sardou.py

@@ -0,0 +1,60 @@
+from pathlib import Path
+import json
+from ruamel.yaml import YAML
+
+from .validation import validate_template
+from .requirements import tosca_to_ask_dict
+
+class DotDict:
+    def __init__(self, **entries):
+        for k, v in entries.items():
+            if isinstance(v, dict):
+                v = DotDict(**v)
+            elif isinstance(v, list):
+                v = [DotDict(**i) if isinstance(i, dict) else i for i in v]
+            setattr(self, k, v)
+    def __getitem__(self, key):
+        return getattr(self, key)
+    def __setitem__(self, key, value):
+        setattr(self, key, value)
+    def __delitem__(self, key):
+        delattr(self, key)
+    def __contains__(self, key):
+        return hasattr(self, key)
+    def __repr__(self):
+        return repr(self._to_dict())
+    def _to_dict(self):
+        result = {}
+        for key, value in self.__dict__.items():
+            if isinstance(value, DotDict):
+                result[key] = value._to_dict()
+            elif isinstance(value, list):
+                result[key] = [
+                    v._to_dict() if isinstance(v, DotDict) else v for v in value
+                ]
+            else:
+                result[key] = value
+        return result
+
+    def _to_json(self, indent=None, **kwargs):
+        return json.dumps(self._to_dict(), indent=indent, **kwargs)
+
+class Sardou(DotDict):
+    def __init__(self, path):
+        path = Path(path)
+        if not path.exists():
+            raise FileNotFoundError(f"File does not exist: {path}")
+        if not validate_template(path):
+            raise ValueError(f"Validation failed for: {path}")
+        yaml = YAML(typ='safe')
+        with path.open('r') as f:
+            data = yaml.load(f)
+        super().__init__(**data)
+
+    def get_requirements(self):
+        return tosca_to_ask_dict(self._to_dict())
+    
+    def get_qos(self, indent=None, **kwargs):
+        policies = self.service_template.policies
+        return [p._to_dict() if isinstance(p, DotDict) else p for p in policies]
+        

sardou-0.1.0/sardou/validation.py

@@ -0,0 +1,68 @@
+import subprocess
+import sys
+from pathlib import Path
+from tempfile import NamedTemporaryFile
+from ruamel.yaml import YAML
+
+PUCCINI_CMD = "/usr/bin/puccini-tosca"
+PUCCINI_FLAGS = ["-x", "data_types.string.permissive"]
+
+# Read and update YAML using ruamel.yaml
+yaml = YAML()
+
+def prevalidate(file_path: Path) -> bool:
+    # Check if file exists
+    if not file_path.exists():
+        print(f"File does not exist: {file_path}")
+        return False
+    
+    try:
+        with file_path.open('r') as f:
+            data = yaml.load(f)
+    except Exception as e:
+        print(f"Error reading YAML file {file_path}: {e}")
+        return False
+    if not data:
+        print(f"No YAML content found")
+        return False
+    imports = data.get('imports', [])
+    nodes = data["service_template"].get('node_templates', {})
+    
+    for imp in imports:
+        if isinstance(imp, dict) and 'profile' in imp:
+            imp['url'] = imp.pop('profile')
+
+    for _, node in nodes.items():
+        node.pop('node_filter', None)
+
+
+    return data
+
+
+def validate_template(file_path: Path) -> bool:
+    # will run the puccini-tosca parse <with flag>
+    yaml_data = prevalidate(file_path)
+
+    # open a temp file
+    with NamedTemporaryFile() as temp_file:
+        yaml.dump(yaml_data, temp_file)
+
+        try:
+            result = subprocess.run(
+                [PUCCINI_CMD, "parse", str(temp_file.name)] + PUCCINI_FLAGS,
+                capture_output=True,
+                text=True
+            )
+            if result.returncode == 0:
+                print(f"Processed successfully: {file_path} \n")
+                return True
+            else:
+                print(f"Failed to process: {file_path} \n")
+                print("==== Error Output ====")
+                print(result.stderr.strip() or result.stdout.strip())
+                print("======================")
+                return False
+    
+        except FileNotFoundError:
+            print(f"Puccini not found at {PUCCINI_CMD}. Please install it first.")
+            sys.exit(1)

sardou-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+