ApiLogicServer 15.2.0__py3-none-any.whl → 15.2.3__py3-none-any.whl

api_logic_server_cli/api_logic_server.py

@@ -12,10 +12,10 @@ ApiLogicServer CLI: given a database url, create [and run] customizable ApiLogic
 Called from api_logic_server_cli.py, by instantiating the ProjectRun object.
 '''
 
-__version__ = "15.02.00"  # last public release: 15.01.03
+__version__ = "15.02.03"  # last public release: 15.02.00
 recent_changes = \
     f'\n\nRecent Changes:\n' +\
-    "\t10/21/2025 - 15.02.00: Copilot test creation from rules and custom APIs \n"\
+    "\t10/22/2025 - 15.02.03: Copilot test creation from rules and custom APIs with issues [103, 104] \n"\
     "\t10/06/2025 - 15.01.06: Incorrect dbml reln arrows [102] \n"\
     "\t09/27/2025 - 15.01.05: Error reporting for bad test data rebuild [101], Minor fix to ensure react-app cards have links \n"\
     "\t08/17/2025 - 15.01.03: LogicBan 01.30, with fix for copy_children[19] \n"\

api_logic_server_cli/prototypes/base/.github/.copilot-instructions.md

@@ -44,6 +44,28 @@ If the user asks "what do I do now?", these subsections are good suggestions.
 
 List these as choices, do not just do all of them at once - that would be overwhelming.
 
+### 📚 Main Services Available in This Project
+
+This GenAI-Logic project provides 13 main customization services:
+
+1. **Run Project** - F5 debug or `python api_logic_server_run.py`
+2. **Adding Business Logic** - Declarative rules in `logic/declare_logic.py`
+3. **Discovery Systems** - Auto-load logic and APIs from discovery folders
+4. **Automated Testing** - Behave tests with BLT (Business Logic Traceability) reports
+5. **Adding MCP** - Model Context Protocol client integration
+6. **Configuring Admin UI** - Edit `ui/admin/admin.yaml`
+7. **Create React Apps** - Custom UIs with `genai-logic genai-add-app`
+8. **Security - RBAC** - Role-based access control with `als add-auth`
+9. **Custom API Endpoints** - Add routes in `api/customize_api.py`
+10. **B2B Integration APIs** - Complex endpoints with Row Dict Mappers
+11. **Customize Models** - Add tables, attributes, derived fields
+12. **Adding Events** - Row events for Kafka, webhooks, integrations
+13. **Critical Patterns** - React components, null-safe constraints, test repeatability
+
+Each service is detailed below with examples and best practices.
+
+---
+
 ### Set Up Virtual Environment
 If it is not already set, you can often find a `venv` in the GenAI-Logic Manager - a parent or grandparent directory.
 

api_logic_server_cli/prototypes/base/docs/training/testing.md

@@ -25,6 +25,9 @@ Step 5.  SUGGEST how to run tests (DO NOT run automatically)
 
 **CRITICAL PRE-TEST CHECKLIST:**
 - [ ] Step 1c completed? (Custom APIs discovered)
+- [ ] **Database values verified?** (Rule #10: Run SQL to check actual prices/flags)
+  - [ ] `sqlite3 db.sqlite "SELECT name, unit_price, carbon_neutral FROM product;"`
+  - [ ] Don't assume product attributes - verify BEFORE writing expectations!
 - [ ] **Step ordering verified?** (Most specific → Most general)
   - [ ] @when patterns: carbon neutral > multi-item > single-item
   - [ ] @given patterns: multi-item > single-item
@@ -470,19 +473,28 @@ Rule.sum(derive=Customer.balance, as_sum_of=Order.amount_total,
 ```python
 # ALWAYS check actual product prices/flags before writing test expectations!
 
-# Check prices:
-# sqlite3 db.sqlite "SELECT name, unit_price, carbon_neutral FROM Product;"
+# Check prices AND flags:
+# sqlite3 db.sqlite "SELECT name, unit_price, carbon_neutral FROM product;"
 
-# Widget=90, Gadget=150, Green=109
+# Results:
+# 1|Gadget|150|1        ← carbon_neutral = 1 (TRUE)
+# 2|Widget|90|          ← carbon_neutral = NULL (not carbon neutral!)
+# 3|Thingamajig|5075|
+# 4|Doodad|110|
+# 5|Green|109|1         ← carbon_neutral = 1 (TRUE)
 
-# ❌ WRONG - Assumed Widget=$100
-# Expected: 10 * 100 = 1000
+# ❌ WRONG - Assumed Widget is carbon neutral
+# Scenario: Carbon Neutral Discount
+#   When B2B order placed with 10 carbon neutral Widget
+#   Then balance should be 810  # Expected 10 * 90 * 0.9 = 810
+# FAILS: Widget is NOT carbon neutral → no discount → balance = 900
 
-# ✅ CORRECT - Verified Widget=$90  
-# Expected: 10 * 90 = 900
+# ✅ CORRECT - Verified Gadget IS carbon neutral (flag = 1)
+# Scenario: Carbon Neutral Discount
+#   When B2B order placed with 10 carbon neutral Gadget
+#   Then balance should be 1350  # Correct: 10 * 150 * 0.9 = 1350
 
-# For carbon neutral discount (10% off when qty >= 10):
-# Expected: 10 * 90 * 0.9 = 810
+# CRITICAL: Don't assume product attributes - VERIFY with SQL first!
 ```
 
 ### Rule #11: Step Definitions Must Match Feature Files ⚠️ NEW

api_logic_server_cli/prototypes/base/test/api_logic_server_behave/behave_logic_report.py

@@ -95,14 +95,43 @@ def show_logic(scenario: str, logic_logs_dir: str):
         last_rules_start = -1
         last_rules_end = -1
         
-        # First, find the LAST "These Rules Fired" section
-        for i, each_logic_line in enumerate(logic_lines):
-            if "These Rules Fired" in each_logic_line:
-                last_rules_start = i + 1  # Start collecting from next line
-                last_rules_end = -1  # Reset end marker to find the next COMPLETE
-            elif last_rules_start > 0 and last_rules_end == -1:
-                if 'Logic Phase:' in each_logic_line and 'COMPLETE' in each_logic_line:
-                    last_rules_end = i
+        # Find ALL "These Rules Fired" sections and choose the one with the most rules
+        rules_sections = []
+        i = 0
+        while i < len(logic_lines):
+            if "These Rules Fired" in logic_lines[i]:
+                start_pos = i + 1
+                # Find the end of this rules section
+                end_pos = start_pos
+                while end_pos < len(logic_lines):
+                    if 'Logic Phase:' in logic_lines[end_pos] and 'COMPLETE' in logic_lines[end_pos]:
+                        break
+                    end_pos += 1
+                
+                # Count non-empty rule lines in this section (after removing trailers)
+                rule_count = 0
+                for j in range(start_pos, end_pos):
+                    line = remove_trailer(logic_lines[j]).strip()
+                    if line and not line.startswith('Logic Phase:'):
+                        rule_count += 1
+                
+                rules_sections.append({
+                    'start': start_pos,
+                    'end': end_pos,
+                    'rule_count': rule_count
+                })
+                i = end_pos
+            else:
+                i += 1
+        
+        # Choose the section with the most rules
+        if rules_sections:
+            best_section = max(rules_sections, key=lambda x: x['rule_count'])
+            last_rules_start = best_section['start']
+            last_rules_end = best_section['end']
+        else:
+            last_rules_start = -1
+            last_rules_end = -1
                     
         # Now process the file, collecting logic log and extracting the last rules section
         for i, each_logic_line in enumerate(logic_lines):
@@ -182,36 +211,27 @@ def main(behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
 
     just_saw_then = False
     current_scenario = ""
+    previous_scenario = ""
     for each_line in contents:
-        # Show logic when we hit a blank line after assertions OR when starting a new scenario
-        if just_saw_then and (each_line == "\n" or each_line.startswith("  Scenario")):
+        if just_saw_then and each_line == "\n":
             show_logic(scenario=current_scenario, logic_logs_dir=scenario_logs)
             just_saw_then = False
-            
+            previous_scenario = ""
         if each_line.startswith("Feature"):
             wiki_data.append("&nbsp;")
             wiki_data.append("&nbsp;")
             each_line = "## " + each_line
-            
         if each_line.startswith("  Scenario"):
-            # Extract scenario name for logic lookup
-            current_scenario = each_line.strip().replace("Scenario: ", "").replace("  ", " ").strip()
-            wiki_data.append("&nbsp;")
-            wiki_data.append("&nbsp;")
-            wiki_data.append("### " + each_line[2:])  # Add scenario header
+            # Before starting new scenario, show logic for previous one if we saw Then
+            if just_saw_then and previous_scenario:
+                show_logic(scenario=previous_scenario, logic_logs_dir=scenario_logs)
+            just_saw_then = False
             each_line = tab + each_line
-            
         if each_line.startswith("    Given") or \
                 each_line.startswith("    When") or \
-                each_line.startswith("    Then") or \
-                each_line.startswith("    And"):
-            if each_line.startswith("    Then") or each_line.startswith("    And"):
+                each_line.startswith("    Then"):
+            if each_line.startswith("    Then"):
                 just_saw_then = True
-            # Add subtle formatting to keywords
-            for keyword in ["Given", "When", "Then", "And"]:
-                if f"    {keyword} " in each_line:
-                    each_line = each_line.replace(f"    {keyword} ", f"    **{keyword}** ")
-                    break
             each_line = tab + tab + each_line
 
         each_line = each_line[:-1]
@@ -219,13 +239,19 @@ def main(behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
         if debug_loc > 0:
             each_line = each_line[0 : debug_loc]
         each_line = each_line.rstrip()
+        if "Scenario" in each_line:
+            current_scenario = each_line[18:]
+            previous_scenario = current_scenario
+            wiki_data.append("&nbsp;")
+            wiki_data.append("&nbsp;")
+            wiki_data.append("### " + each_line[8:])
 
         each_line = each_line + "  "  # wiki for "new line"
         
         wiki_data.append(each_line)
-
-    # Show logic for the last scenario
-    if current_scenario and just_saw_then:
+    
+    # Show logic for the last scenario if we saw Then
+    if just_saw_then and current_scenario:
         show_logic(scenario=current_scenario, logic_logs_dir=scenario_logs)
 
     with open(wiki, 'w') as rpt:

api_logic_server_cli/prototypes/base/test/api_logic_server_behave/behave_logic_report.py.bak

@@ -0,0 +1,285 @@
+import requests
+from pathlib import Path
+import os
+import ast
+import sys
+import click
+
+"""
+Creates wiki file from test/behave/behave.log, with rule use.
+
+Tips
+* use 2 spaces (at end) for newline
+* for tab: & emsp;
+
+"""
+
+tab = " "
+behave_debug_info = " # "
+wiki_data = []
+debug_scenario = "XXGood Order Custom Service"
+
+scenario_doc_strings = {}
+""" dict of scenario_name, array of strings """
+
+
+def remove_trailer(line: str) -> str:
+    """ remove everything after the ## """
+    end_here = line.find("\t\t##")
+    result = line[0:end_here]
+    return result
+
+def line_spacer():
+    wiki_data.append("\n")
+    wiki_data.append(" ")
+    wiki_data.append(" ")
+    wiki_data.append("\n")
+
+
+def get_current_readme(prepend_wiki: str):
+    """ initialize wiki_data with readme up to {report_name} """
+    report_name = "Behave Logic Report"
+    with open(prepend_wiki) as readme:
+        readme_lines = readme.readlines()
+    need_spacer = True
+    for each_readme_line in readme_lines:
+        if '# ' + report_name in each_readme_line:
+            need_spacer = False
+            break
+        wiki_data.append(each_readme_line[0:-1])
+    if need_spacer:
+        line_spacer()
+    wiki_data.append(f'# {report_name}')
+
+def get_truncated_scenario_name(scenario_name: str) -> str:
+    """ address max file length (chop at 26), illegal characters """
+    scenario_trunc = scenario_name
+    if scenario_trunc is not None and len(scenario_trunc) >= 26:
+        scenario_trunc = scenario_name[0:25]
+    scenario_trunc = f'{str(scenario_trunc).replace(" ", "_")}'
+    return scenario_trunc
+
+
+def show_logic(scenario: str, logic_logs_dir: str):
+    """ insert s{logic_logs_dir}/scenario.log into wiki_data as disclosure area """
+    scenario_trunc = get_truncated_scenario_name(scenario)
+    logic_file_name = f'{logic_logs_dir}/{scenario_trunc}.log'
+    logic_file_name_path = Path(logic_file_name)
+    if not logic_file_name_path.is_file():  # debug code
+        # wiki_data.append(f'unable to find Logic Log file: {logic_file_name}')
+        if scenario == debug_scenario:
+            print(f'RELATIVE: {logic_file_name} in {os.getcwd()}')
+            full_name = f'{os.getcwd()}/{logic_file_name}'
+            print(f'..FULL: {os.getcwd()}/{logic_file_name}')
+            logic_file_name = '{logic_logs_dir}/test.log'
+            with open(logic_file_name) as logic:
+                logic_lines = logic.readlines()
+    else:
+        logic_log = []
+        rules_used = []
+        wiki_data.append("<details markdown>")
+        wiki_data.append("<summary>Tests - and their logic - are transparent.. click to see Logic</summary>")
+        line_spacer()
+        scenario_trunc = get_truncated_scenario_name(scenario)
+        if scenario_trunc in scenario_doc_strings:
+            wiki_data.append(f'**Logic Doc** for scenario: {scenario}')
+            wiki_data.append("   ")
+            for each_doc_string_line in scenario_doc_strings[scenario_trunc]:
+                wiki_data.append(each_doc_string_line[0: -1])
+            line_spacer()
+        wiki_data.append(f'**Rules Used** in Scenario: {scenario}')
+        wiki_data.append("```")
+        with open(logic_file_name) as logic:
+            logic_lines = logic.readlines()
+        is_logic_log = True
+        last_rules_start = -1
+        last_rules_end = -1
+        
+        # First, find the LAST "These Rules Fired" section
+        for i, each_logic_line in enumerate(logic_lines):
+            if "These Rules Fired" in each_logic_line:
+                last_rules_start = i + 1  # Start collecting from next line
+                last_rules_end = -1  # Reset end marker to find the next COMPLETE
+            elif last_rules_start > 0 and last_rules_end == -1:
+                if 'Logic Phase:' in each_logic_line and 'COMPLETE' in each_logic_line:
+                    last_rules_end = i
+                    
+        # Now process the file, collecting logic log and extracting the last rules section
+        for i, each_logic_line in enumerate(logic_lines):
+            each_logic_line = remove_trailer(each_logic_line)
+            
+            if is_logic_log:
+                if "These Rules Fired" in each_logic_line:
+                    is_logic_log = False
+                else:
+                    logic_log.append(each_logic_line)
+            
+            # Extract rules from the last "These Rules Fired" section
+            if last_rules_start <= i < last_rules_end:
+                # Skip empty lines
+                if each_logic_line.strip():
+                    wiki_data.append(each_logic_line + "  ")
+        
+        wiki_data.append("```")
+        wiki_data.append(f'**Logic Log** in Scenario: {scenario}')
+        wiki_data.append("```")
+        for each_logic_log in logic_log:
+            each_line = remove_trailer(each_logic_log)
+            wiki_data.append(each_line)
+        wiki_data.append("```")
+        wiki_data.append("</details>")
+
+
+def get_docStrings(steps_dir: str):
+    steps_dir_files = os.listdir(steps_dir)
+    indent = 4  # skip leading blanks
+    for each_steps_dir_file in steps_dir_files:
+        each_steps_dir_file_path = Path(steps_dir).joinpath(each_steps_dir_file)
+        if each_steps_dir_file_path.is_file():
+            with open(each_steps_dir_file_path) as f:
+                step_code = f.readlines()
+            # print(f'Found File: {str(each_steps_dir_file_path)}')
+            for index, each_step_code_line in enumerate(step_code):
+                if each_step_code_line.startswith('@when'):
+                    comment_start = index + 2
+                    if '"""' in step_code[comment_start]:
+                        # print(".. found doc string")
+                        doc_string_line = comment_start+1
+                        doc_string = []
+                        while (True):
+                            if '"""' in step_code[doc_string_line]:
+                                break
+                            doc_string.append(step_code[doc_string_line][indent:])
+                            doc_string_line += 1
+                        scenario_line = doc_string_line+1
+                        if 'scenario_name' not in step_code[scenario_line]:
+                            print(f'\n** Warning - scenario_name not found '\
+                                f'in file {str(each_steps_dir_file_path)}, '\
+                                f'after line {scenario_line} -- skipped')
+                        else:
+                            scenario_code_line = step_code[scenario_line]
+                            scenario_name_start = scenario_code_line.find("'") + 1
+                            scenario_name_end = scenario_code_line[scenario_name_start+1:].find("'")
+                            scenario_name = scenario_code_line[scenario_name_start: 
+                                scenario_name_end + scenario_name_start+1]
+                            if scenario_name == debug_scenario:
+                                print(f'got {debug_scenario}')
+                            scenario_trunc = get_truncated_scenario_name(scenario_name)
+                            # print(f'.... truncated scenario_name: {scenario_trunc} in {scenario_code_line}')
+                            scenario_doc_strings[scenario_trunc] = doc_string
+    # print("that's all, folks")
+
+
+def main(behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
+    """ main driver """
+    get_docStrings(steps_dir="features/steps")
+
+    get_current_readme(prepend_wiki=prepend_wiki)
+
+    contents = None
+    with open(behave_log) as f:
+        contents = f.readlines()
+
+    just_saw_then = False
+    current_scenario = ""
+    for each_line in contents:
+        # Show logic when we hit a blank line after assertions OR when starting a new scenario
+        if just_saw_then and (each_line == "\n" or each_line.startswith("  Scenario")):
+            show_logic(scenario=current_scenario, logic_logs_dir=scenario_logs)
+            just_saw_then = False
+            
+        if each_line.startswith("Feature"):
+            wiki_data.append("&nbsp;")
+            wiki_data.append("&nbsp;")
+            each_line = "## " + each_line
+            
+        if each_line.startswith("  Scenario"):
+            # Extract scenario name for logic lookup
+            current_scenario = each_line.strip().replace("Scenario: ", "").replace("  ", " ").strip()
+            wiki_data.append("&nbsp;")
+            wiki_data.append("&nbsp;")
+            wiki_data.append("### " + each_line[2:])  # Add scenario header
+            each_line = tab + each_line
+            
+        if each_line.startswith("    Given") or \
+                each_line.startswith("    When") or \
+                each_line.startswith("    Then") or \
+                each_line.startswith("    And"):
+            if each_line.startswith("    Then") or each_line.startswith("    And"):
+                just_saw_then = True
+            # Add subtle formatting to keywords
+            for keyword in ["Given", "When", "Then", "And"]:
+                if f"    {keyword} " in each_line:
+                    each_line = each_line.replace(f"    {keyword} ", f"    **{keyword}** ")
+                    break
+            each_line = tab + tab + each_line
+
+        each_line = each_line[:-1]
+        debug_loc = each_line.find(behave_debug_info)
+        if debug_loc > 0:
+            each_line = each_line[0 : debug_loc]
+        each_line = each_line.rstrip()
+
+        each_line = each_line + "  "  # wiki for "new line"
+        
+        wiki_data.append(each_line)
+
+    # Show logic for the last scenario
+    if current_scenario and just_saw_then:
+        show_logic(scenario=current_scenario, logic_logs_dir=scenario_logs)
+
+    with open(wiki, 'w') as rpt:
+        rpt.write('\n'.join(wiki_data))
+    wiki_full_path = Path(wiki).absolute()
+    print(f'Wiki Output: {wiki_full_path}\n\n')
+
+
+
+def print_args(args, msg):
+    print(msg)
+    for each_arg in args:
+        print(f'  {each_arg}')
+    print(" ")
+
+
+@click.group()
+@click.pass_context
+def cli(ctx):
+    """
+    Combine behave.log and scenario_logic_logs to create Behave Logic Report
+
+    """
+    pass
+
+
+@cli.command("run")
+@click.pass_context
+@click.option('--behave_log',
+              default=f'logs/behave.log',  # cwd set to test/api_logic_server_behave
+              # prompt="Log from behave test suite run [behave.log]",
+              help="Help")
+@click.option('--scenario_logs',
+              default=f'logs/scenario_logic_logs',
+              # prompt="Logic Log directory from ",
+              help="Help")
+@click.option('--wiki',
+              default=f'reports/Behave Logic Report.md',
+              # prompt="Log from behave test suite run [api_logic_server_behave]",
+              help="Help")
+@click.option('--prepend_wiki',
+              default=f'reports/Behave Logic Report Intro micro.md',
+              # prompt="Log from behave test suite run [Behave Logic Report Intro]",
+              help="Help")
+def run(ctx, behave_log: str, scenario_logs: str, wiki: str, prepend_wiki: str):
+    main(behave_log = behave_log, scenario_logs = scenario_logs, wiki = wiki, prepend_wiki = prepend_wiki)
+
+
+if __name__ == '__main__':  # debugger & python command line start here
+    # eg: python api_logic_server_cli/cli.py create --project_name=~/Desktop/test_project
+    # unix: python api_logic_server_cli/cli.py create --project_name=/home/ApiLogicProject
+
+    print(f'\nBehave Logic Report 1.1, started at {os.getcwd()}')
+    commands = sys.argv
+    if len(sys.argv) > 1:
+        print_args(commands, f'\n\nCommand Line Arguments:')
+    cli()

api_logic_server_cli/prototypes/basic_demo/customizations/test/api_logic_server_behave/reports/Behave Logic Report Intro micro.md

@@ -0,0 +1,35 @@
+## Basic Demo Sample
+
+This is a basic demonstration project created from a simple natural language prompt using API Logic Server's GenAI capabilities.
+
+### Data Model
+
+![Basic Demo Data Model](https://apilogicserver.github.io/Docs/images/basic_demo/basic_demo_data_model.jpeg)
+
+### Creation Prompt
+
+This project was created from the following natural language prompt:
+
+```
+Create a system with customers, orders, items and products.
+
+Include a notes field for orders.
+
+Use case: Check Credit    
+    1. The Customer's balance is less than the credit limit
+    2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
+    3. The Order's amount_total is the sum of the Item amount
+    4. The Item amount is the quantity * unit_price
+    5. The Item unit_price is copied from the Product unit_price
+
+Use case: App Integration
+    1. Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None.
+```
+
+The sample Scenarios below were chosen to illustrate the basic patterns of using rules. Open the disclosure box ("Tests - and their logic...") to see the implementation and notes.
+
+The following report was created during test suite execution.
+
+ 
+
+# Behave Logic Report

api_logic_server_cli/prototypes/basic_demo/customizations/test/api_logic_server_behave/reports/Behave Logic Report Intro.md

@@ -0,0 +1,35 @@
+## Basic Demo Sample
+
+This is a basic demonstration project created from a simple natural language prompt using API Logic Server's GenAI capabilities (with a custom Behave Report Intro).
+
+### Data Model
+
+![Basic Demo Data Model](https://apilogicserver.github.io/Docs/images/basic_demo/basic_demo_data_model.jpeg)
+
+### Creation Prompt
+
+This project was created from the following natural language prompt:
+
+```
+Create a system with customers, orders, items and products.
+
+Include a notes field for orders.
+
+Use case: Check Credit    
+    1. The Customer's balance is less than the credit limit
+    2. The Customer's balance is the sum of the Order amount_total where date_shipped is null
+    3. The Order's amount_total is the sum of the Item amount
+    4. The Item amount is the quantity * unit_price
+    5. The Item unit_price is copied from the Product unit_price
+
+Use case: App Integration
+    1. Send the Order to Kafka topic 'order_shipping' if the date_shipped is not None.
+```
+
+The sample Scenarios below were chosen to illustrate the basic patterns of using rules. Open the disclosure box ("Tests - and their logic...") to see the implementation and notes.
+
+The following report was created during test suite execution.
+
+ 
+
+# Behave Logic Report