Adjust repo files

CHANGELOG.md

@@ -4,9 +4,15 @@
 ## Unreleased
 
 
-## Release 0.143
+## Release 0.144
 
 ### Changed
+- Split out PHP extensions int separate directories
+
+
+## Release 0.143
+
+### Added
 - Added `phalcon` 5.x to PHP 8.0 and PHP 8.1
 
 

bin/modules-generate.py

@@ -0,0 +1,264 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Generate Ansible group_vars from module definition."""
+import os
+import sys
+from collections import OrderedDict
+from typing import Dict, List, Optional, Any
+import yaml
+
+
+# --------------------------------------------------------------------------------------------------
+# GLOBALS
+# --------------------------------------------------------------------------------------------------
+
+SCRIPT_PATH = str(os.path.dirname(os.path.realpath(__file__)))
+REPOSITORY_PATH = str(os.path.dirname(SCRIPT_PATH))
+PHP_MODULE_PATH = str(os.path.join(REPOSITORY_PATH, "php_modules"))
+GROUP_VARS_PATH = str(os.path.join(REPOSITORY_PATH, ".ansible", "group_vars", "all"))
+
+
+# --------------------------------------------------------------------------------------------------
+# HELPER FUNCTIONS
+# --------------------------------------------------------------------------------------------------
+
+
+def get_el_by_name(items: List[Dict[str, Any]], name: str) -> Dict[str, Any]:
+    """Returns an element from a dict list by its 'name' key with given value."""
+    for item in items:
+        if item["name"] == name:
+            return item
+    print("error, key name not found by value", name, "in list: ", items)
+    sys.exit(1)
+
+
+def load_yaml(path: str) -> Dict[str, Any]:
+    """Load yaml file and return its dict()."""
+    with open(path, "r", encoding="utf8") as fp:
+        data = yaml.safe_load(fp)
+        return data
+
+
+def load_yaml_raw(path: str, indent: int = 0) -> str:
+    """Load and returns yaml file as str."""
+    lines = []
+    with open(path, "r", encoding="utf8") as fp:
+        for line in fp:
+            # Remove: empty lines and ---
+            if line in ("---\n", "---\r\n", "\n", "\r\n"):
+                continue
+            # Remove: comments
+            if line.startswith("#"):
+                continue
+            lines.append(" " * indent + line)
+    return "".join(lines)
+
+
+# --------------------------------------------------------------------------------------------------
+# MODULE FUNCTIONS
+# --------------------------------------------------------------------------------------------------
+
+
+def get_module_options(module_dirname: str) -> Dict[str, Any]:
+    """Returns yaml dict options of a PHP module given by its absolute file path."""
+    return load_yaml(os.path.join(PHP_MODULE_PATH, module_dirname, "options.yml"))
+
+
+def get_module_build(module_dirname: str) -> Dict[str, Any]:
+    """Returns yaml dict build configuration of a PHP module given by its absolute file path."""
+    return load_yaml(os.path.join(PHP_MODULE_PATH, module_dirname, "build.yml"))
+
+
+def get_module_test(module_dirname: str) -> Dict[str, Any]:
+    """Returns yaml dict test configuration of a PHP module given by its absolute file path."""
+    return load_yaml(os.path.join(PHP_MODULE_PATH, module_dirname, "test.yml"))
+
+
+def get_modules(mod_name: Optional[str] = None) -> List[Dict[str, Any]]:
+    """Returns a list of PHP module directory names.
+
+    Args:
+        mod_name: If specified, only get this module (and its dependencies).
+    """
+    modules = []
+    with os.scandir(PHP_MODULE_PATH) as it:
+        for item in it:
+            if not item.name.startswith(".") and item.is_dir():
+                data = get_module_options(item.name)
+                modules.append(
+                    {"dir": item.name, "name": data["name"], "deps": data["depends_build"]}
+                )
+    # Convert list of deps into dict(dir, name, deps)
+    items = []
+    for module in modules:
+        if module["deps"]:
+            deps = []
+            for dep in module["deps"]:
+                deps.append(get_el_by_name(modules, dep))
+            module["deps"] = deps
+            items.append(module)
+        else:
+            items.append(module)
+    # Check if we only want to read a single module
+    if mod_name:
+        return [get_el_by_name(items, mod_name)]
+    return sorted(items, key=lambda item: item["dir"])
+
+
+def get_module_dependency_tree(modules: List[Dict[str, Any]]) -> OrderedDict[str, Any]:
+    """Returns dictionary of module dependency tree."""
+    module_tree = OrderedDict()  # type: OrderedDict[str, Any]
+
+    for module in modules:
+        mod_name = module["name"]
+        mod_deps = module["deps"]
+
+        module_tree[mod_name] = {}
+
+        # Do we have module requirements?
+        if len(mod_deps) > 0:
+            module_tree[mod_name] = get_module_dependency_tree(mod_deps)
+    return module_tree
+
+
+def resolve_module_dependency_tree(tree: OrderedDict[str, Any]) -> List[str]:
+    """Returns sorted list of resolved dependencies."""
+    resolved = []
+    for key, _ in tree.items():
+        # Has dependenies
+        if tree[key]:
+            childs = resolve_module_dependency_tree(tree[key])
+            for child in childs:
+                if child not in resolved:
+                    resolved.append(child)
+        # Add current node, if not already available
+        if key not in resolved:
+            resolved.append(key)
+    return resolved
+
+
+# --------------------------------------------------------------------------------------------------
+# PRINT FUNCTIONS
+# --------------------------------------------------------------------------------------------------
+
+
+def print_modules(modules: List[Dict[str, Any]]) -> None:
+    """Print directory modules."""
+    for module in modules:
+        print(module["dir"] + "/")
+        print("   name:", module["name"])
+        print("   deps:", end=" ")
+        for dep in module["deps"]:
+            print(dep["name"], end=", ")
+        print()
+
+
+def print_dependency_tree(tree: Dict[str, Any], lvl: int = 0) -> None:
+    """Print dependency tree of modules."""
+    for key, value in tree.items():
+        print(" " * lvl, "-", key)
+        if value:
+            print_dependency_tree(tree[key], lvl + 2)
+
+
+# --------------------------------------------------------------------------------------------------
+# WRITE ANSIBLE GROUP_VARS FUNCTIONS
+# --------------------------------------------------------------------------------------------------
+
+
+def write_group_vars(modules: List[str]) -> None:
+    """Write mods.yml group_vars for ansible."""
+    group_vars = os.path.join(GROUP_VARS_PATH, "mods.yml")
+
+    with open(group_vars, "w", encoding="utf8") as fp:
+        fp.write("---\n\n")
+        fp.write("# DO NOT ALTER THIS FILE - IT IS AUTOGENERATED.\n\n")
+
+        # Enabled modules
+        fp.write("# The following specifies the order in which modules are being built.\n")
+        fp.write("extensions_enabled:\n")
+        for module in modules:
+            fp.write("  - " + module + "\n")
+        fp.write("\n\n")
+
+        # Build defines modules
+        fp.write("# The following specifies how modules are being built.\n")
+        fp.write("extensions_available:\n")
+        for module in modules:
+            opts = get_module_options(module)
+            fp.write("  " + module + ":\n")
+            fp.write("    disabled: [" + ", ".join(str(x) for x in opts["exclude"]) + "]\n")
+            fp.write(load_yaml_raw(os.path.join(PHP_MODULE_PATH, module, "build.yml"), 4))
+
+
+# --------------------------------------------------------------------------------------------------
+# MAIN FUNCTION
+# --------------------------------------------------------------------------------------------------
+def print_help() -> None:
+    """Show help screen."""
+    print("Usage:", os.path.basename(__file__), "[php-module]")
+    print("      ", os.path.basename(__file__), "-h, --help")
+    print()
+    print("This script will generate the Ansible group_vars file: .ansible/group_vars/all/mods.yml")
+    print("based on all the modules found in php_modules/ directory.")
+    print()
+    print("Optional arguments:")
+    print("    [php-module]    When specifying a name of a php-module, the group_vars file will")
+    print("                    only be generated for this single module (and its dependencies).")
+    print("                    This is useful if you want to test new modules and not build all")
+    print("                    previous modules in the Dockerfile.")
+    print()
+    print("                    Note: You still need to generate the Dockerfiles via Ansible for")
+    print("                          the changes to take effect, before building the image.")
+
+
+def main(argv: List[str]) -> None:
+    """Main entrypoint."""
+    if not (len(argv) == 0 or len(argv) == 1):
+        print_help()
+        sys.exit(1)
+    if len(argv) == 1:
+        if argv[0] == "--help" or argv[0] == "-h":
+            print_help()
+            sys.exit(0)
+
+    single_module = None
+    if len(argv) == 1:
+        single_module = argv[0]
+
+    # Get modules in order of dependencies
+    modules = get_modules(single_module)
+    module_tree = get_module_dependency_tree(modules)
+    names = resolve_module_dependency_tree(module_tree)
+
+    print("#", "-" * 78)
+    print("# Paths")
+    print("#", "-" * 78)
+    print("Repository: ", REPOSITORY_PATH)
+    print("PHP Module: ", PHP_MODULE_PATH)
+    print("Group Vars: ", GROUP_VARS_PATH)
+    print()
+
+    print("#", "-" * 78)
+    print("# Module directories")
+    print("#", "-" * 78)
+    print_modules(modules)
+    print()
+
+    print("#", "-" * 78)
+    print("# Build Dependency Tree")
+    print("#", "-" * 78)
+    print_dependency_tree(module_tree)
+    print()
+
+    print("#", "-" * 78)
+    print("# Build order")
+    print("#", "-" * 78)
+    print("\n".join(names))
+
+    # Create group_vars file mods.yml
+    write_group_vars(names)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

bin/modules-validate.py

@@ -0,0 +1,6 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+"""Validate defined modules."""
+print("Not yet implemented *///*")
+print()
+print("Run modules-generate.py instead, as it also kind of validates.")

build/README.md

@@ -1,51 +0,0 @@
-# Build helper
-
-This directory contains all tools for building.
-
-## `ansible/`
-
-The `ansible/` directory contains a setup to generate all Dockerfiles. Once generated, they will be placed or updated into [../Dockerfiles](../Dockerfiles).
-
-**How to generate via ansible command**
-```bash
-# From inside ansible directory
-cd ansible
-ansible-playbook generate.yml --diff
-```
-
-**How to generate via Makefile**
-```bash
-# From inside root git directory
-cd ..
-make generate
-```
-
-**Requirements**
-
-In order to generate Dockerfiles, you will have to have ansible installed:
-```
-pip install ansible
-```
-
-## `gen-readme.sh`
-
-`gen-readme.sh` will update the README.md with currently enabled PHP modules for each Docker image.
-
-**How to update the README.md**
-
-```bash
-# Update for all Docker images
-./gen-readme.sh
-
-# Update for specific Docker image
-./gen-readme.sh 5.4
-./gen-readme.sh 5.5
-./gen-readme.sh 5.6
-./gen-readme.sh 7.0
-./gen-readme.sh 7.1
-./gen-readme.sh 7.2
-```
-
-**Requirements**
-
-If you want to update the README.md for a specific Docker image, you must have built this image prior running `gen-readme.sh`.