Generate Workspace using Gita

This change adds the capability to generate a workspace directly from the known_good.json file. To achieve this, the known_good.json file is transformed into a configuration file for a git workspace management tool called gita, which is then used to check out all mentioned modules on the specific commit/branch that is given in known_good.json. In addition, the score_modules.MODULE.bazel is updated with local_path_overrides to the checked out modules. Hence, a bazel build will immediately work as expected.

# Conflicts:
#	.gitignore

Author: opajonk

.devcontainer/devcontainer.json

@@ -1,5 +1,6 @@
 {
     "name": "eclipse-s-core",
-    "image": "ghcr.io/eclipse-score/devcontainer:1.0.0",
+    "image": "ghcr.io/eclipse-score/devcontainer:v1.1.0",
+    "postCreateCommand": "bash .devcontainer/prepare_workspace.sh",
     "postStartCommand": "ssh-keygen -f '/home/vscode/.ssh/known_hosts' -R '[localhost]:2222' || true"
 }

.devcontainer/prepare_workspace.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+set -euo pipefail
+
+# Install pipx
+sudo apt update
+sudo apt install -y pipx
+
+# Install gita
+pipx install gita
+
+# Enable bash autocompletion for gita
+echo "eval \"\$(register-python-argcomplete gita -s bash)\"" >> ~/.bashrc
+
+# Set GITA_PROJECT_HOME environment variable
+echo "export GITA_PROJECT_HOME=$(pwd)/.gita" >> ~/.bashrc
+GITA_PROJECT_HOME=$(pwd)/.gita
+mkdir -p "$GITA_PROJECT_HOME"
+export GITA_PROJECT_HOME
+
+# Generate .gita-workspace.csv from known_good.json
+python3 tools/known_good_to_gita_workspace.py known_good.json .gita-workspace.csv
+python3 tools/update_module_from_known_good.py --override-type local_path
+
+# Automagically clone repositories listed in .gita-workspace.csv
+echo "Cloning repositories listed in .gita-workspace.csv..."
+gita clone --preserve-path --from-file .gita-workspace.csv
+# Output the status of all cloned repositories
+echo "Status of all cloned repositories:"
+gita ll

.gitignore

@@ -22,3 +22,8 @@ __pycache__/
 /_build
 /docs/ubproject.toml
 /docs/_collections
+
+# Workspace files
+/score_*/
+/.gita/
+/.gita-workspace.csv

tools/known_good_to_gita_workspace.py

@@ -0,0 +1,50 @@
+#!/usr/bin/env python3
+import argparse
+import json
+import csv
+
+MODULES_CSV_HEADER = [
+    "repo_url",
+    "name",
+    "workspace_path",
+    "version",
+    "hash",
+    "branch"
+]
+
+def main():
+    parser = argparse.ArgumentParser(description="Convert known_good.json to baseline.csv format.")
+    parser.add_argument("input_json", help="Path to known_good.json")
+    parser.add_argument("output_csv", help="Path to output baseline.csv")
+    args = parser.parse_args()
+
+    with open(args.input_json, "r") as f:
+        data = json.load(f)
+
+    modules = data.get("modules", {})
+    rows = []
+    for name, info in modules.items():
+        repo_url = info.get("repo", "")
+        if not repo_url:
+            raise RuntimeError("repo must not be empty")
+        
+        # default branch: main
+        branch = info.get("branch", "main")
+        
+        # if no hash is given, use branch
+        hash_ = info.get("hash", branch)
+        
+        # workspace_path is not available in known_good.json, default to name of repository
+        workspace_path = name
+        
+        # gita format: {url},{name},{path},{prop['type']},{repo_flags},{branch}
+        row = [repo_url, name, workspace_path, "", "", hash_]
+        rows.append(row)
+
+    with open(args.output_csv, "w", newline="") as f:
+        writer = csv.writer(f)
+        for row in rows:
+            writer.writerow(row)
+
+if __name__ == "__main__":
+    main()

tools/update_module_from_known_good.py

@@ -90,8 +90,24 @@ def generate_git_override_blocks(modules_dict: Dict[str, Any], repo_commit_dict:
 
     return blocks
 
+def generate_local_override_blocks(modules_dict: Dict[str, Any]) -> List[str]:
+    """Generate bazel_dep and local_path_override blocks for each module."""
+    blocks = []
+    
+    for name, module in modules_dict.items():
+        block = (
+            f'bazel_dep(name = "{name}")\n'
+            'local_path_override(\n'
+            f'    module_name = "{name}",\n'
+            f'    path = "{name}",\n'
+            ')\n'
+        )
+        
+        blocks.append(block)
+    
+    return blocks
 
-def generate_file_content(modules: Dict[str, Any], repo_commit_dict: Dict[str, str], timestamp: Optional[str] = None) -> str:
+def generate_file_content(args: argparse.Namespace, modules: Dict[str, Any], repo_commit_dict: Dict[str, str], timestamp: Optional[str] = None) -> str:
     """Generate the complete content for score_modules.MODULE.bazel."""
     # License header assembled with parenthesis grouping (no indentation preserved in output).
     header = (
@@ -117,7 +133,15 @@ def generate_file_content(modules: Dict[str, Any], repo_commit_dict: Dict[str, s
             "\n"
         )
 
-    blocks = generate_git_override_blocks(modules, repo_commit_dict)
+    if args.override_type == "git":
+        blocks = generate_git_override_blocks(modules, repo_commit_dict)
+    else:
+        header += (
+            "# Note: This file uses local_path overrides. Ensure that local paths are set up correctly.\n"
+            "\n"
+        )
+        blocks = generate_local_override_blocks(modules)
+
 
     if not blocks:
         raise SystemExit("No valid modules to generate git_override blocks")
@@ -149,6 +173,12 @@ def main() -> None:
         action="append",
         help="Override commit for a specific repo (format: <REPO_URL>@<COMMIT_SHA>)"
     )
+    parser.add_argument(
+        "--override-type",
+        choices=["local_path", "git"],
+        default="git",
+        help="Type of override to use (default: git)"
+    )
 
     args = parser.parse_args()
 
@@ -180,7 +210,7 @@ def main() -> None:
 
     # Generate file content
     timestamp = data.get("timestamp") or datetime.now().isoformat()
-    content = generate_file_content(modules, repo_commit_dict, timestamp)
+    content = generate_file_content(args, modules, repo_commit_dict, timestamp)
 
     if args.dry_run:
         print(f"Dry run: would write to {output_path}\n")
@@ -191,7 +221,7 @@ def main() -> None:
     else:
         with open(output_path, "w", encoding="utf-8") as f:
             f.write(content)
-        print(f"Generated {output_path} with {len(modules)} git_override entries")
+        print(f"Generated {output_path} with {len(modules)} {args.override_type}_override entries")
 
 
 if __name__ == "__main__":