Track build folders with git and render configs

Author: tjazerzen

codeplain_REST_api.py

@@ -1,5 +1,9 @@
+from typing import Optional
+
 import requests
 
+from plain2code_state import RunState
+
 
 class FunctionalRequirementTooComplex(Exception):
     def __init__(self, message, proposed_breakdown=None):
@@ -36,6 +40,14 @@ class LinkMustHaveTextSpecified(Exception):
     pass
 
 
+class NoRenderFound(Exception):
+    pass
+
+
+class MultipleRendersFound(Exception):
+    pass
+
+
 class CodeplainAPI:
 
     def __init__(self, api_key):
@@ -49,7 +61,13 @@ def api_url(self):
     def api_url(self, value):
         self._api_url = value
 
-    def post_request(self, endpoint_url, headers, payload):
+    def _extend_payload_with_run_state(self, payload: dict, run_state: RunState):
+        run_state.increment_call_count()
+        payload["render_state"] = run_state.to_dict()
+
+    def post_request(self, endpoint_url, headers, payload, run_state: Optional[RunState]):
+        if run_state is not None:
+            self._extend_payload_with_run_state(payload, run_state)
         response = requests.post(endpoint_url, headers=headers, json=payload)
 
         try:
@@ -83,6 +101,12 @@ def post_request(self, endpoint_url, headers, payload):
             if response_json["error_code"] == "LinkMustHaveTextSpecified":
                 raise LinkMustHaveTextSpecified(response_json["message"])
 
+            if response_json["error_code"] == "NoRenderFound":
+                raise NoRenderFound(response_json["message"])
+
+            if response_json["error_code"] == "MultipleRendersFound":
+                raise MultipleRendersFound(response_json["message"])
+
         response.raise_for_status()
 
         return response_json
@@ -106,9 +130,16 @@ def get_plain_source_tree(self, plain_source, loaded_templates):
 
         payload = {"plain_source": plain_source, "loaded_templates": loaded_templates}
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, None)
 
-    def render_functional_requirement(self, frid, plain_source_tree, linked_resources, existing_files_content):
+    def render_functional_requirement(
+        self,
+        frid,
+        plain_source_tree,
+        linked_resources,
+        existing_files_content,
+        run_state: RunState,
+    ):
         """
         Renders the content of a functional requirement based on the provided ID,
         plain source tree, and existing files' content.
@@ -138,9 +169,17 @@ def render_functional_requirement(self, frid, plain_source_tree, linked_resource
             "existing_files_content": existing_files_content,
         }
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
-    def fix_unittests_issue(self, frid, plain_source_tree, linked_resources, existing_files_content, unittests_issue):
+    def fix_unittests_issue(
+        self,
+        frid,
+        plain_source_tree,
+        linked_resources,
+        existing_files_content,
+        unittests_issue,
+        run_state: RunState,
+    ):
         endpoint_url = f"{self.api_url}/fix_unittests_issue"
         headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}
 
@@ -152,9 +191,9 @@ def fix_unittests_issue(self, frid, plain_source_tree, linked_resources, existin
             "unittests_issue": unittests_issue,
         }
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
-    def refactor_source_files_if_needed(self, frid, files_to_check, existing_files_content):
+    def refactor_source_files_if_needed(self, frid, files_to_check, existing_files_content, run_state: RunState):
         endpoint_url = f"{self.api_url}/refactor_source_files_if_needed"
         headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}
 
@@ -164,10 +203,16 @@ def refactor_source_files_if_needed(self, frid, files_to_check, existing_files_c
             "existing_files_content": existing_files_content,
         }
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
     def render_conformance_tests(
-        self, frid, functional_requirement_id, plain_source_tree, linked_resources, existing_files_content
+        self,
+        frid,
+        functional_requirement_id,
+        plain_source_tree,
+        linked_resources,
+        existing_files_content,
+        run_state: RunState,
     ):
         endpoint_url = f"{self.api_url}/render_conformance_tests"
         headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}
@@ -180,9 +225,15 @@ def render_conformance_tests(
             "existing_files_content": existing_files_content,
         }
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
-    def generate_folder_name_from_functional_requirement(self, frid, functional_requirement, existing_folder_names):
+    def generate_folder_name_from_functional_requirement(
+        self,
+        frid,
+        functional_requirement,
+        existing_folder_names,
+        run_state: RunState,
+    ):
         endpoint_url = f"{self.api_url}/generate_folder_name_from_functional_requirement"
         headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}
 
@@ -192,7 +243,7 @@ def generate_folder_name_from_functional_requirement(self, frid, functional_requ
             "existing_folder_names": existing_folder_names,
         }
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
     def fix_conformance_tests_issue(
         self,
@@ -206,6 +257,7 @@ def fix_conformance_tests_issue(
         acceptance_tests,
         conformance_tests_issue,
         implementation_fix_count,
+        run_state: RunState,
     ):
         endpoint_url = f"{self.api_url}/fix_conformance_tests_issue"
         headers = {"X-API-Key": self.api_key, "Content-Type": "application/json"}
@@ -225,7 +277,7 @@ def fix_conformance_tests_issue(
         if acceptance_tests is not None:
             payload["acceptance_tests"] = acceptance_tests
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)
 
     def render_acceptance_tests(
         self,
@@ -235,6 +287,7 @@ def render_acceptance_tests(
         existing_files_content,
         conformance_tests_files,
         acceptance_test,
+        run_state: RunState,
     ):
         """
         Renders acceptance tests based on the provided parameters.
@@ -267,4 +320,4 @@ def render_acceptance_tests(
             "acceptance_test": acceptance_test,
         }
 
-        return self.post_request(endpoint_url, headers, payload)
+        return self.post_request(endpoint_url, headers, payload, run_state)

examples/example_hello_world_golang/config.yaml

@@ -0,0 +1,4 @@
+verbose: true
+debug: true
+unittests-script: ../../test_scripts/run_unittests_golang.sh
+conformance-tests-script: ../../test_scripts/run_conformance_tests_golang.sh

examples/example_hello_world_golang/run.sh

@@ -1,49 +1,24 @@
 # Store command line arguments
 VERBOSE=0
-API_ENDPOINT=""
+CONFIG_FILE="config.yaml"
 
-# Parse command line arguments
-while [[ $# -gt 0 ]]; do
-    case $1 in
-        -v|--verbose)
-            VERBOSE=1
-            shift # Remove --verbose from processing
-            ;;
-        --render-range)
-            shift
-            RENDER_RANGE=$1
-            shift
-            ;;
-        --render-from)
-            shift
-            RENDER_FROM=$1
-            shift
-            ;;
-        --api)
-            API_ENDPOINT="$2"
-            shift # Remove --api from processing
-            shift # Remove the API endpoint value from processing
-            ;;
-        *)
-            # Unknown option
-            echo "Unknown option: $1"
-            exit 1
-            ;;
-    esac
-done
+# Check if verbose is set in config.yaml and set VERBOSE accordingly
+if grep -q "verbose: true" "$CONFIG_FILE" 2>/dev/null; then
+    VERBOSE=1
+fi
 
 if [ $VERBOSE -eq 1 ]; then
     echo "Running Go lang hello world example in verbose mode."
 fi
 
-# Construct the command with optional parameters
-CMD="python ../../plain2code.py hello_world_golang.plain --unittests-script=../../test_scripts/run_unittests_golang.sh --conformance-tests-script=../../test_scripts/run_conformance_tests_golang.sh ${VERBOSE:+-v} ${RENDER_RANGE:+"--render-range=$RENDER_RANGE"} ${RENDER_FROM:+"--render-from=$RENDER_FROM"} ${API_ENDPOINT:+"--api $API_ENDPOINT"}"
-
-# Removing all the conformance tests before rendering the hello world example.
-rm -rf conformance_tests
+# Check if render-range and render-from exist in config.yaml
+if ! (grep -q "render-range:" $CONFIG_FILE || grep -q "render-from:" $CONFIG_FILE); then
+    echo "Removing conformance tests folder"
+    rm -rf conformance_tests
+fi
 
 # Execute the command
-$CMD
+python ../../plain2code.py hello_world_golang.plain
 
 # Check if the plain2code command failed
 if [ $? -ne 0 ]; then

examples/example_hello_world_python/config.yaml

@@ -0,0 +1,5 @@
+unittests-script: ../../test_scripts/run_unittests_python.sh
+conformance-tests-script: ../../test_scripts/run_conformance_tests_python.sh
+v: true  # verbose flag, defaults to false if not set
+debug: true  # debug flag, defaults to false if not set
+api: http://127.0.0.1:5000

examples/example_hello_world_python/run.sh

@@ -1,51 +1,23 @@
-# Store command line arguments
+CONFIG_FILE="config.yaml"
 VERBOSE=0
-API_ENDPOINT=""
 
-# Parse command line arguments
-while [[ $# -gt 0 ]]; do
-    case $1 in
-        -v|--verbose)
-            VERBOSE=1
-            shift # Remove --verbose from processing
-            ;;
-        --render-range )
-            shift
-            RENDER_RANGE=$1
-            shift
-            ;;
-        --render-from)
-            shift
-            RENDER_FROM=$1
-            shift
-            ;;
-        --api)
-            API_ENDPOINT="$2"
-            shift # Remove --api from processing
-            shift # Remove the API endpoint value from processing
-            ;;
-        *)
-            # Unknown option
-            echo "Unknown option: $1"
-            exit 1
-            ;;
-    esac
-done
+# Check if verbose is set in config.yaml and set VERBOSE accordingly
+if grep -q "verbose: true" "$CONFIG_FILE" 2>/dev/null; then
+    VERBOSE=1
+fi
 
 if [ $VERBOSE -eq 1 ]; then
-    echo "Running Python hello world example in verbose mode."
+    echo "Running the hello world example for Python in verbose mode."
 fi
 
-# Construct the command with optional parameters
-CMD="python ../../plain2code.py hello_world_python.plain --unittests-script=../../test_scripts/run_unittests_python.sh --conformance-tests-script=../../test_scripts/run_conformance_tests_python.sh ${VERBOSE:+-v} ${RENDER_RANGE:+"--render-range=$RENDER_RANGE"} ${RENDER_FROM:+"--render-from=$RENDER_FROM"} ${API_ENDPOINT:+"--api $API_ENDPOINT"}"
-
-if [ -z "$RENDER_RANGE" ] || [ -z "$RENDER_FROM" ]; then
+# Check if render-range and render-from exist in config.yaml
+if ! (grep -q "render-range:" $CONFIG_FILE || grep -q "render-from:" $CONFIG_FILE); then
     echo "Removing conformance tests folder"
     rm -rf conformance_tests
 fi
 
 # Execute the command
-$CMD
+python ../../plain2code.py hello_world_python.plain
 
 # Check if the plain2code command failed
 if [ $? -ne 0 ]; then

examples/example_hello_world_react/run.sh

@@ -1,40 +1,25 @@
-# Store command line arguments
 VERBOSE=0
-API_ENDPOINT=""
-
-# Parse command line arguments
-while [[ $# -gt 0 ]]; do
-    case $1 in
-        -v|--verbose)
-            VERBOSE=1
-            shift # Remove --verbose from processing
-            ;;
-        --api)
-            API_ENDPOINT="$2"
-            shift # Remove --api from processing
-            shift # Remove the API endpoint value from processing
-            ;;
-        *)
-            # Unknown option
-            echo "Unknown option: $1"
-            exit 1
-            ;;
-    esac
-done
+CONFIG_FILE="config.yaml"
+
+# Check if verbose is set in config.yaml and set VERBOSE accordingly
+if grep -q "verbose: true" "$CONFIG_FILE" 2>/dev/null; then
+    VERBOSE=1
+fi
+
 
 if [ $VERBOSE -eq 1 ]; then
     echo "Running the hello world example for React in verbose mode."
 fi
 
-# Construct the command with optional parameters
-CMD="python ../../plain2code.py hello_world_react.plain --conformance-tests-script=../../test_scripts/run_conformance_tests_cypress.sh ${VERBOSE:+-v} ${RENDER_RANGE:+"--render-range=$RENDER_RANGE"} ${RENDER_FROM:+"--render-from=$RENDER_FROM"} ${API_ENDPOINT:+"--api $API_ENDPOINT"}"
-
-# Removing all the conformance tests before rendering the hello world example.
-rm -rf conformance_tests
-rm -rf node_conformance_tests
+# Check if render-range and render-from exist in config.yaml
+if ! (grep -q "render-range:" $CONFIG_FILE || grep -q "render-from:" $CONFIG_FILE); then
+    echo "Removing conformance tests folder"
+    rm -rf conformance_tests
+    rm -rf node_conformance_tests
+fi
 
 # Execute the command
-$CMD
+python ../../plain2code.py hello_world_react.plain
 
 # Check if the plain2code command failed
 if [ $? -ne 0 ]; then