Merge pull request #3 from rabea-al/main

Flask Component library maintenance

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,44 @@
+---
+name: Bug Report
+about: Share your findings to help us squash those bugs
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**What kind of bug is it?**
+- [ ] Xircuits Component Library Code
+- [ ] Workflow Example
+- [ ] Documentation
+- [ ] Not Sure
+
+**Xircuits Version**
+Run `pip show xircuits` to get the version, or mention you've used a specific .whl from a branch.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Tested on?**
+
+- [ ] Windows  
+- [ ] Linux Ubuntu 
+- [ ] Centos 
+- [ ] Mac  
+- [ ] Others  (State here -> xxx )  
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,31 @@
+---
+name: Feature Request
+about: Suggest an idea for this component library
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Xircuits Version**
+Run `pip show xircuits` to get the version, or mention you've used a specific .whl from a branch.
+
+**What kind of feature is it?**
+- [ ] Xircuits Component Library Code
+- [ ] Workflow Example
+- [ ] Documentation
+- [ ] Not Sure
+
+**Is your feature request related to a problem? Please describe.**
+
+A clear and concise description of what the problem is. Ex. When I use X feature / when I do Y it does Z.
+
+**Describe the solution you'd like**
+
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,46 @@
+Welcome to Xircuits! Thank you for making a pull request. Please ensure that your pull request follows the template.
+
+# Description
+
+Please include a summary which includes relevant motivation and context. You may also describe the code changes. List any dependencies that are required for this change.
+
+## References
+
+If applicable, note issue numbers this pull request addresses. You can also note any other pull requests that address this issue and how this pull request is different.
+
+## Pull Request Type
+
+- [ ] Xircuits Component Library Code
+- [ ] Workflow Example
+- [ ] Documentation
+- [ ] Others (Please Specify)
+
+## Type of Change
+
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+# Tests
+
+Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+**1. Test A**
+
+    1. First step
+    2. Second step
+    3. ...
+
+
+## Tested on?
+
+- [ ] Windows  
+- [ ] Linux Ubuntu 
+- [ ] Centos 
+- [ ] Mac  
+- [ ] Others  (State here -> xxx )  
+
+# Notes
+
+Add if any.

.github/workflows/run-workflow-tests.yml

@@ -0,0 +1,139 @@
+name: Run Xircuits Workflows Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: "*"
+  workflow_dispatch:
+
+jobs:
+  build-and-run:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+    env:
+      TEST_XIRCUITS: |
+        examples/DeclarativeExample.xircuits
+        examples/InlineExample.xircuits
+        
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Create virtual environment
+      run: |
+        python -m venv venv
+        echo "${{ github.workspace }}/venv/bin" >> $GITHUB_PATH
+
+    - name: Install xircuits in virtual environment
+      run: pip install xircuits
+
+    - name: Set Environment Variables
+      run: |
+        LIBRARY_NAME=$(echo "${GITHUB_REPOSITORY##*/}" | sed 's/-/_/g')
+        echo "LIBRARY_NAME=$LIBRARY_NAME" >> $GITHUB_ENV
+        COMPONENT_LIBRARY_PATH="xai_components/${LIBRARY_NAME}"
+        echo "COMPONENT_LIBRARY_PATH=$COMPONENT_LIBRARY_PATH" >> $GITHUB_ENV
+        if [ "${{ github.event_name }}" == "pull_request" ]; then
+          echo "BRANCH_NAME=${{ github.head_ref }}" >> $GITHUB_ENV
+        else
+          echo "BRANCH_NAME=${GITHUB_REF#refs/heads/}" >> $GITHUB_ENV
+        fi
+
+    - name: List Xircuits
+      run: xircuits list
+
+    - name: Clone Repository
+      run: |
+        rm -rf ${{ env.COMPONENT_LIBRARY_PATH }}
+        if [ "${{ github.event_name }}" == "pull_request" ]; then
+          REPO_URL="${{ github.event.pull_request.head.repo.clone_url }}"
+        else
+          REPO_URL="https://github.com/${{ github.repository }}"
+        fi
+        git clone -b ${{ env.BRANCH_NAME }} $REPO_URL ${{ env.COMPONENT_LIBRARY_PATH }}
+
+    - name: Install Component Library
+      run: |
+        if [ -f "${{ env.COMPONENT_LIBRARY_PATH }}/requirements.txt" ]; then
+          echo "requirements.txt found, installing dependencies..."
+          pip install -r ${{ env.COMPONENT_LIBRARY_PATH }}/requirements.txt
+        else
+          echo "requirements.txt not found."
+        fi
+          
+    - name: Test Flask .xircuits Workflow
+      run: |
+          export PYTHONPATH="${GITHUB_WORKSPACE}:${PYTHONPATH}"
+          LOG_FILE="${GITHUB_WORKSPACE}/workflow_logs.txt"
+          TEST_FILES=$(echo "$TEST_XIRCUITS" | tr '\n' ' ')
+          echo "Starting Flask .xircuits workflow test..." > $LOG_FILE
+          IFS=' ' read -r -a FILE_ARRAY <<< "$TEST_FILES"
+          if [ ${#FILE_ARRAY[@]} -eq 0 ]; then
+            echo "Error: No .xircuits files specified for testing." | tee -a $LOG_FILE
+            exit 1
+          fi
+          for FILE in "${FILE_ARRAY[@]}"; do
+            FULL_PATH="${COMPONENT_LIBRARY_PATH}/${FILE}"
+            echo "Processing file: $FULL_PATH" | tee -a $LOG_FILE
+            if [ ! -f "$FULL_PATH" ]; then
+              echo "Error: Xircuits file not found at $FULL_PATH" | tee -a $LOG_FILE
+              exit 1
+            fi
+            echo "Compiling Xircuits workflow: ${FULL_PATH}" >> $LOG_FILE
+            xircuits compile "$FULL_PATH" "${FULL_PATH%.*}.py" 2>&1 | tee -a $LOG_FILE
+            if [ ! -f "${FULL_PATH%.*}.py" ]; then
+              echo "Error: Compiled Python file not found at ${FULL_PATH%.*}.py" | tee -a $LOG_FILE
+              exit 1
+            fi
+            echo "Running Python script: ${FULL_PATH%.*}.py" >> $LOG_FILE
+            python "${FULL_PATH%.*}.py" 2>&1 | tee -a $LOG_FILE &
+            PYTHON_PID=$!
+            echo "Waiting for Flask server to initialize..." >> $LOG_FILE
+            sleep 10
+            TEST_ENDPOINT="http://127.0.0.1:8080/hello/world"
+            RETRIES=3
+            SUCCESS=0
+            for i in $(seq 1 $RETRIES); do
+              echo "Attempt $i: Checking endpoint $TEST_ENDPOINT..." | tee -a $LOG_FILE
+              if curl -s "$TEST_ENDPOINT" | grep -q "Hello World!"; then
+                echo "Flask test successful: Endpoint $TEST_ENDPOINT is running as expected." | tee -a $LOG_FILE
+                SUCCESS=1
+                break
+              else
+                echo "Attempt $i failed. Retrying in 5 seconds..." | tee -a $LOG_FILE
+                sleep 5
+              fi
+            done
+            if [ $SUCCESS -ne 1 ]; then
+              echo "Flask test failed: Endpoint $TEST_ENDPOINT did not respond as expected after $RETRIES attempts." | tee -a $LOG_FILE
+              if ps -p $PYTHON_PID > /dev/null; then
+                echo "Killing Python script process (PID: $PYTHON_PID)..." >> $LOG_FILE
+                kill -9 $PYTHON_PID
+              fi
+              exit 1
+            fi
+            if ps -p $PYTHON_PID > /dev/null; then
+              echo "Python script ran successfully for the duration of the test. Killing the process..." | tee -a $LOG_FILE
+              kill -9 $PYTHON_PID
+            else
+              echo "Python script finished execution before the test completed." | tee -a $LOG_FILE
+            fi
+            echo "Completed testing file: $FULL_PATH" | tee -a $LOG_FILE
+          done
+          echo "All Flask and Python script tests completed successfully." >> $LOG_FILE
+      
+    - name: Upload log file
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: ${{ env.LIBRARY_NAME }}-validation-workflow-${{ matrix.python-version }}
+        path: ${{ github.workspace }}/workflow_logs.txt