Refactored, added --link

Author: RhetTbull

applecrate/build.py

@@ -0,0 +1,128 @@
+"""Build a macOS installer package"""
+
+from __future__ import annotations
+
+import pathlib
+import shutil
+import subprocess
+
+import click
+from click import echo
+
+from .utils import copy_and_create_parents
+
+BUILD_DIR = pathlib.Path("build/darwin")
+
+
+def clean_build_dir(build_dir: pathlib.Path):
+    """Clean the build directory."""
+    if not build_dir.exists():
+        return
+
+    for file in build_dir.iterdir():
+        if file.is_file():
+            file.unlink()
+        else:
+            shutil.rmtree(file)
+
+
+def create_build_dirs(build_dir: pathlib.Path):
+    """Create build directory."""
+
+    print(f"Creating build directory {build_dir}")
+    # files will be created in the build directory
+    build_dir.mkdir(exist_ok=True, parents=True, mode=0o755)
+
+    # Resources contains the welcome and conclusion HTML files
+    resources = build_dir / "Resources"
+    resources.mkdir(exist_ok=True, mode=0o755)
+    echo(f"Created {resources}")
+
+    # scripts contains postinstall and preinstall scripts
+    scripts = build_dir / "scripts"
+    scripts.mkdir(exist_ok=True, mode=0o755)
+    echo(f"Created {scripts}")
+
+    # darwinpkg subdirectory is the root for files to be in installed
+    darwinpkg = build_dir / "darwinpkg"
+    darwinpkg.mkdir(exist_ok=True, mode=0o755)
+    echo(f"Created {darwinpkg}")
+
+    # package subdirectory is the root for the macOS installer package
+    package = build_dir / "package"
+    package.mkdir(exist_ok=True, mode=0o755)
+    echo(f"Created {package}")
+
+    # pkg subdirectory is location of final macOS installer product
+    pkg = build_dir / "pkg"
+    pkg.mkdir(exist_ok=True, mode=0o755)
+    echo(f"Created {pkg}")
+
+
+def check_dependencies():
+    """Check for dependencies."""
+    echo("Checking for dependencies.")
+    if not shutil.which("pkgbuild"):
+        raise click.ClickException("pkgbuild is not installed")
+    if not shutil.which("productbuild"):
+        raise click.ClickException("productbuild is not installed")
+
+
+def build_package(app: str, version: str, target_directory: str):
+    """Build the macOS installer package."""
+    pkg = f"{target_directory}/package/{app}.pkg"
+    proc = subprocess.run(
+        [
+            "pkgbuild",
+            "--identifier",
+            f"org.{app}.{version}",
+            "--version",
+            version,
+            "--scripts",
+            f"{target_directory}/scripts",
+            "--root",
+            f"{target_directory}/darwinpkg",
+            pkg,
+        ],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    if proc.returncode != 0:
+        raise click.ClickException(f"pkgbuild failed: {proc.returncode} {proc.stderr.decode('utf-8')}")
+    echo(f"Created {pkg}")
+
+
+def build_product(app: str, version: str, target_directory: str):
+    """Build the macOS installer package."""
+    product = f"{target_directory}/pkg/{app}-{version}.pkg"
+    proc = subprocess.run(
+        [
+            "productbuild",
+            "--distribution",
+            f"{target_directory}/Distribution",
+            "--resources",
+            f"{target_directory}/Resources",
+            "--package-path",
+            f"{target_directory}/package",
+            product,
+        ],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+    )
+    if proc.returncode != 0:
+        raise click.ClickException(f"productbuild failed: {proc.returncode} {proc.stderr.decode('utf-8')}")
+    echo(f"Created {product}")
+
+
+def stage_install_files(src: str, dest: str, build_dir: pathlib.Path):
+    """Stage install files in the build directory."""
+    src = pathlib.Path(src)
+    try:
+        dest = pathlib.Path(dest).relative_to("/")
+    except ValueError:
+        dest = pathlib.Path(dest)
+    target = build_dir / "darwinpkg" / pathlib.Path(dest)
+    if src.is_file():
+        copy_and_create_parents(src, target)
+    else:
+        shutil.copytree(src, target)

applecrate/cli.py

@@ -31,10 +31,10 @@ def cli():
     pass
 
 
-@cli.command()
-def init():
-    """Create a new applecrate project."""
-    echo("Creating a new applecrate project.")
+# @cli.command()
+# def init():
+#     """Create a new applecrate project."""
+#     echo("Creating a new applecrate project.")
 
 
 # @cli.command()
@@ -104,6 +104,16 @@ def init():
     "will install the file 'dist/app' to '/usr/local/bin/app-1.0.0' "
     "if --app=app and --version=1.0.0.",
 )
+@click.option(
+    "--link",
+    "-k",
+    metavar="SRC TARGET",
+    nargs=2,
+    multiple=True,
+    help="Create a symbolic link from SRC to DEST after installation. "
+    "SRC and TARGET must be absolute paths and both may include template variables {{ app }} and {{ version }}. "
+    'For example: `--link "/Library/Application Support/{{ app }}/{{ version }}/app" "/usr/local/bin/{{ app }}-{{ version }}"` ',
+)
 @click.option(
     "--post-install",
     "-p",
@@ -136,6 +146,7 @@ def build(**kwargs):
     no_uninstall = kwargs["no_uninstall"]
     url = kwargs["url"]
     install = kwargs["install"]
+    link = kwargs["link"]
     license = kwargs["license"]
     banner = kwargs["banner"]
     post_install = kwargs["post_install"]
@@ -148,6 +159,8 @@ def build(**kwargs):
         "url": url,
         "install": install,
         "banner": banner,
+        "link": link,
+        "post_install": post_install,
     }
 
     echo(f"Building installer package for {app} version {version}.")
@@ -182,16 +195,25 @@ def build(**kwargs):
         pathlib.Path(target).chmod(0o755)
         echo(f"Created {target}")
 
-    echo("Creating post-install script")
+    echo("Creating post-install scripts")
     target = BUILD_DIR / "scripts" / "postinstall"
-    if post_install:
-        copy_and_create_parents(post_install, target)
-    else:
-        template = get_template("postinstall")
-        render_template(template, data, target)
+    template = get_template("postinstall")
+    render_template(template, data, target)
     pathlib.Path(target).chmod(0o755)
     echo(f"Created {target}")
 
+    target = BUILD_DIR / "scripts" / "links"
+    template = get_template("links")
+    render_template(template, data, target)
+    pathlib.Path(target).chmod(0o755)
+    echo(f"Created {target}")
+
+    if post_install:
+        target = BUILD_DIR / "scripts" / "postinstall_user"
+        copy_and_create_parents(post_install, target)
+        pathlib.Path(target).chmod(0o755)
+        echo(f"Created {target}")
+
     if banner:
         echo("Copying banner image")
         target = BUILD_DIR / "Resources" / "banner.png"
@@ -226,6 +248,16 @@ def render_build_kwargs(kwargs: dict[str, Any]) -> dict[str, Any]:
             dest = pathlib.Path(template.render(app=app, version=version))
             new_install.append((src, dest))
         rendered["install"] = new_install
+
+    if link := rendered.get("link"):
+        new_link = []
+        for src, target in link:
+            src_template = Template(str(src))
+            target_template = Template(str(target))
+            src = pathlib.Path(src_template.render(app=app, version=version))
+            target = pathlib.Path(target_template.render(app=app, version=version))
+            new_link.append((src, target))
+        rendered["link"] = new_link
     return rendered
 
 
@@ -276,6 +308,18 @@ def validate_build_kwargs(**kwargs):
             pathlib_install.append((src, dest))
         kwargs["install"] = pathlib_install
 
+    if link := kwargs.get("link"):
+        pathlib_link = []
+        for src, target in link:
+            src = pathlib.Path(src)
+            target = pathlib.Path(target)
+            if not src.is_absolute():
+                raise ValueError(f"Link source {src} must be an absolute path")
+            if not target.is_absolute():
+                raise ValueError(f"Link target {target} must be an absolute path")
+            pathlib_link.append((src, target))
+        kwargs["link"] = pathlib_link
+
     if banner := kwargs.get("banner"):
         banner = pathlib.Path(banner)
         if banner.suffix.lower() != ".png":

applecrate/template_utils.py

@@ -0,0 +1,68 @@
+"""Utilities for working with templates"""
+
+from __future__ import annotations
+
+import pathlib
+
+import markdown2
+from click import echo
+from jinja2 import Environment, PackageLoader, Template, select_autoescape
+
+# extra features to support for Markdown to HTML conversion with markdown2
+MARKDOWN_EXTRAS = ["fenced-code-blocks", "footnotes", "tables"]
+
+
+def load_template_from_file(path: pathlib.Path) -> Template:
+    """Load a Jinja2 template from a file."""
+    with open(path) as file:
+        return Template(file.read())
+
+
+def get_template(name: str) -> Template:
+    """Load a Jinja2 template from the package."""
+
+    env = Environment(loader=PackageLoader("applecrate", "templates"), autoescape=select_autoescape())
+    return env.get_template(name)
+
+
+def render_markdown_template(template: Template, data: dict[str, str], output: pathlib.Path):
+    """Render and save a Jinja2 template to a file, converting markdown to HTML."""
+    md = template.render(**data)
+    html = markdown2.markdown(md, extras=MARKDOWN_EXTRAS)
+    head = (
+        '<head> <meta charset="utf-8" /> <style> body { font-family: Helvetica, sans-serif; font-size: 14px; } </style> </head>'
+    )
+    html = f"<!DOCTYPE html>\n<html>\n{head}\n<body>\n{html}\n</body>\n</html>"
+    output.parent.mkdir(parents=True, exist_ok=True)
+    with open(output, "w") as file:
+        file.write(html)
+
+
+def render_template(template: Template, data: dict[str, str], output: pathlib.Path):
+    """Render and save a Jinja2 template to a file."""
+    rendered = template.render(**data)
+    output.parent.mkdir(parents=True, exist_ok=True)
+    with open(output, "w") as file:
+        file.write(rendered)
+
+
+def create_html_file(
+    input_path: pathlib.Path | None,
+    output_path: pathlib.Path,
+    data: dict[str, str],
+    default_template: str,
+):
+    """Create an HTML file from a markdown or HTML file and render with Jinja2."""
+
+    if input_path:
+        template = load_template_from_file(input_path)
+    else:
+        template = get_template(default_template)
+
+    if not input_path or input_path.suffix.lower() in [".md", ".markdown"]:
+        # passed a markdown file or no file at all
+        render_markdown_template(template, data, output_path)
+    else:
+        render_template(template, data, output_path)
+
+    echo(f"Created {output_path}")

applecrate/templates/links

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+# Create links specified by the user as part of post-install
+
+{% for source, target in link %}
+ln -s "{{ source }}" "{{ target }}"
+{% endfor %}

applecrate/templates/postinstall

@@ -1,5 +1,12 @@
 #!/bin/bash
 
+# Perform post installation tasks here
+
+# Create links if needed
+{% if link %}
+./links
+{% endif %}
+
 #Custermize this for your application
 # APPLICATION_FILE_PATH=bin/wso2server.sh
 

applecrate/utils.py

@@ -0,0 +1,33 @@
+"""Utilities for applecrate"""
+
+from __future__ import annotations
+
+import copy
+import pathlib
+import shutil
+from typing import Any
+
+from click import echo
+
+
+def set_from_defaults(kwargs: dict[str, Any], defaults: dict[str, Any]) -> dict[str, Any]:
+    """Set values in kwargs from defaults if not provided or set to falsy value.
+
+    Args:
+        kwargs: The dictionary of keyword arguments to set.
+        defaults: The default values to set if not provided or set to a falsy value.
+
+    Returns: A new dictionary with the updated values.
+    """
+    updated = copy.deepcopy(kwargs)
+    for key, value in defaults.items():
+        if key not in updated or not updated[key]:
+            updated[key] = value
+    return updated
+
+
+def copy_and_create_parents(src: pathlib.Path, dst: pathlib.Path):
+    """Copy a file to a destination and create any necessary parent directories."""
+    echo(f"Copying {src} to {dst}")
+    dst.parent.mkdir(parents=True, exist_ok=True)
+    shutil.copy(src, dst)