Merge branch 'feature/document-generation-additions' of https://github.com/philips-software/amp-devcontainer into feature/document-generation-additions

Author: rjaegers

docs/support/gherkin-to-csv.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+
+import argparse
+import csv
+import os
+import sys
+from dataclasses import dataclass, asdict, fields
+from typing import List
+from gherkin.parser import Parser
+from gherkin.token_scanner import TokenScanner
+
+@dataclass
+class Rule:
+    """A class representing a rule extracted from a Gherkin feature file."""
+    identifier: str
+    description: str
+
+    @classmethod
+    def field_names(cls) -> List[str]:
+        return [f.name for f in fields(cls)]
+
+def extract_rules_from_feature(file_path):
+    """Parse a Gherkin feature file and extract the rules."""
+    try:
+        with open(file_path, 'r', encoding='utf-8') as file:
+            content = file.read()
+
+        parser = Parser()
+        feature_document = parser.parse(TokenScanner(content))
+        rules = []
+
+        if 'feature' in feature_document:
+            feature = feature_document['feature']
+
+            if 'children' in feature:
+                for child in feature['children']:
+                    if 'rule' in child:
+                        rule = child['rule']
+                        rule_id = rule.get('name', '').strip()
+                        description = rule.get('description', '').strip()
+                        rules.append(Rule(
+                            identifier=rule_id,
+                            description=description
+                        ))
+
+        return rules
+    except Exception as e:
+        print(f"Error parsing {file_path}: {e}", file=sys.stderr)
+        return []
+
+def main():
+    parser = argparse.ArgumentParser(description='Extract rules from Gherkin feature files and save to CSV')
+    parser.add_argument('feature_files', nargs='+', help='Paths to feature files')
+    parser.add_argument('--output', '-o', default='rules.csv', help='Output CSV file path')
+
+    args = parser.parse_args()
+    all_rules = []
+
+    for feature_path in args.feature_files:
+        if os.path.isfile(feature_path):
+            print(f"Processing {feature_path}")
+            rules = extract_rules_from_feature(feature_path)
+            all_rules.extend(rules)
+        else:
+            print(f"File not found: {feature_path}", file=sys.stderr)
+
+    with open(args.output, 'w', newline='', encoding='utf-8') as csvfile:
+        writer = csv.DictWriter(csvfile, fieldnames=Rule.field_names())
+        writer.writeheader()
+        writer.writerows([asdict(rule) for rule in all_rules])
+
+    print(f"Extracted {len(all_rules)} rules to {args.output}")
+
+if __name__ == '__main__':
+    main()

docs/templates/requirements.template.md

@@ -0,0 +1,45 @@
+# amp-devcontainer requirement specification
+
+## Introduction
+
+### Purpose
+
+This document describes the software system requirements for amp-devcontainer.
+
+### Definitions of key words
+
+The key words *MUST*, *MUST NOT*, *REQUIRED*, *SHALL*, *SHALL NOT*, *SHOULD*, *SHOULD NOT*, *RECOMMENDED*, *MAY*, and *OPTIONAL* in this document are to be interpreted as described in [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119).
+
+### Abstract
+
+amp-devcontainer is a set of [devcontainers](https://containers.dev/) tailored towards modern, embedded, software development.
+
+The containers may be used both for local development and continuous integration (ci).
+
+### Terminology and Abbreviations
+
+| Terminology and Abbreviations | Description/Definition                                                                                                                                         |
+|-------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| ARM                           | A family of RISC architectures for computer processors and micro controllers, formerly an acronym for Advanced RISC Machines and originally Acorn RISC Machine |
+| Continuous Integration (ci)   | The practice of continuously merging developers work to a shared code-base; ideally including automation for build, test and deployment                        |
+| ELF                           | Executable and Linkable Format, formerly named Extensible Linking Format                                                                                       |
+| RISC                          | Reduced Instruction Set Computer                                                                                                                               |
+
+## Requirements
+
+{%- macro reencode(text) -%}
+{{ text.encode('utf-8').decode('unicode_escape') }}
+{%- endmacro -%}
+
+{%- macro sbdl_id_to_header(text) -%}
+{{ text.replace('_', ' ') }}
+{%- endmacro -%}
+
+{% for req_id, requirement in sbdl.items() %}
+{% if requirement.type == 'requirement' %}
+### {{ reencode(sbdl_id_to_header(req_id)) }}
+
+{{ reencode(requirement.description) }}
+
+{% endif %}
+{% endfor %}