Enable CI checks for non-editable install

.github/actions/install/action.yml

@@ -1,44 +1,70 @@
 name: Set up IDAES
 description: Install IDAES and extensions
+
 inputs:
-  install-target:
-    description: 'Command-line arguments and options to pass to the install command, e.g. pip install'
+
+  variant:
+    description: "Which installation variant to use. Choices: standard (default); dev"
+    required: false
+    default: standard
+
+  python-version:
+    description: "Python version to use for installation"
     required: true
-  install-command:
-    description: 'Command to use to install `install-target`'
+
+  conda-environment:
+    description: "Name of the Conda environment to use for installation."
+    required: false
+    default: idaes-ui-env
+
+  info-packages:
+    description: Packages to show info for
     required: false
-    default: pip --no-cache-dir install --progress-bar off
+    default: pyomo idaes-pse idaes-ui
+
 runs:
   using: "composite"
   steps:
-      # IMPORTANT this requires the Conda env setup to be run before this action
-    - name: Update pip and other packaging tools using Conda
-      # -l: login shell, needed when using Conda run:
+
+    - name: Set up Conda environment
+      uses: conda-incubator/[email protected]
+      with:
+        activate-environment: ${{ inputs.conda-environment }}
+        python-version: ${{ inputs.python-version }}
+
+    - name: Check out repository
+      if: inputs.variant == 'dev'
+      uses: actions/checkout@v3
+    - name: Install using pip (requirements-dev.txt)
+      if: inputs.variant == 'dev'
       shell: bash -l {0}
       run: |
-        echo '::group::Output of "conda install" command'
-        conda install --yes --quiet pip setuptools wheel
-        conda list
-        echo '::endgroup::'
-    - name: Install idaes and dependencies
+        pip install --progress-bar off -r requirements-dev.txt
+
+    - name: Install using pip (git+... URL)
+      if: inputs.variant == 'standard'
       shell: bash -l {0}
+      env:
+        _pip_install_url: ${{ github.server_url }}/${{ github.repository }}@${{ github.ref }}
       run: |
-        echo '::group::Output of "pip install" command'
-        ${{ inputs.install-command }} ${{ inputs.install-target}}
+        pip install --progress-bar off "git+$_pip_install_url" idaes-pse pytest
+
+    - name: Install extensions
+      shell: bash -l {0}
+      run: |
+        echo '::group::Output of "idaes get-extensions" command'
+        idaes get-extensions --verbose
         echo '::endgroup::'
+
+    - name: Display environment info
+      shell: bash -l {0}
+      run: |
         echo '::group::Output of "conda list"'
         conda list
         echo '::endgroup::'
         echo '::group::Output of "pip list"'
         pip list
         echo '::endgroup::'
-        echo '::group::Output of "pip show pyomo idaes-pse"'
-        pip show pyomo idaes-pse
-        echo '::endgroup::'
-        # idaes --version
-    - name: Install extensions
-      shell: bash -l {0}
-      run: |
-        echo '::group::Output of "idaes get-extensions" command'
-        idaes get-extensions --extra petsc --verbose
-        echo '::endgroup::'
+        echo '::group::Output of "pip show ${{ inputs.info-packages }}"'
+        pip show ${{ inputs.info-packages }}
+        echo '::endgroup::'

.github/workflows/core.yml

@@ -33,9 +33,6 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  # default Python version to use for checks that do not require multiple versions
-  DEFAULT_PYTHON_VERSION: '3.8'
-  IDAES_CONDA_ENV_NAME_DEV: idaes-ui-dev
   PYTEST_ADDOPTS: "--color=yes"
 
 defaults:
@@ -44,17 +41,21 @@ defaults:
     shell: bash -l {0}
 
 jobs:
+
   pytest:
-    # description: Run pytest with dev dependencies
-    name: pytest (py${{ matrix.python-version }}/${{ matrix.os }})
+    # description: Run pytest test suite
+    name: pytest (${{ matrix.install-variant }}/py${{ matrix.python-version }}/${{ matrix.os }})
     runs-on: ${{ matrix.runner-image }}
     strategy:
       fail-fast: false
       matrix:
+        install-variant:
+          - standard
+          - dev
         python-version:
           - '3.8'
-          - '3.9'
-          - '3.10'
+        #   - '3.9'
+        #   - '3.10'
           - '3.11'
         os:
           - linux
@@ -65,32 +66,27 @@ jobs:
           - os: win64
             runner-image: windows-2022
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Conda environment
-        uses: conda-incubator/[email protected]
+      - uses: IDAES/idaes-ui/.github/actions/install@refs/pull/41/head
         with:
-          activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
+          variant: ${{ matrix.install-variant }}
           python-version: ${{ matrix.python-version }}
-      - name: Install additional dependencies
-        run: pip install idaes-pse
-      - name: Install the code
-        uses: ./.github/actions/install
-        with:
-          install-target: -r requirements-dev.txt
       - name: Run pytest
-        run: pytest -v -s -m "not integration"
-        
+        run: pytest -v --pyargs idaes_ui.fv
+
   cypress:
-    name: cypress (py${{ matrix.python-version }}/${{ matrix.os }})
+    name: cypress (${{ matrix.install-variant }}/py${{ matrix.python-version }}/${{ matrix.os }})
     #setup python environment for python server, install UI
     runs-on: ${{ matrix.runner-image }}
     strategy:
       fail-fast: false
       matrix:
+        install-variant:
+          - standard
+          - dev
         python-version:
           - '3.8'
-          - '3.9'
-          - '3.10'
+        #   - '3.9'
+        #   - '3.10'
           - '3.11'
         os:
           - linux
@@ -102,29 +98,29 @@ jobs:
             runner-image: windows-2022
     steps:
       #python starts here
-      - uses: actions/checkout@v3
-      - name: Set up Conda environment
-        uses: conda-incubator/[email protected]
+      - name: Install python code
+        uses: IDAES/idaes-ui/.github/actions/install@refs/pull/41/head
         with:
-          activate-environment: ${{ env.IDAES_CONDA_ENV_NAME_DEV }}
+          variant: ${{ matrix.install-variant }}
           python-version: ${{ matrix.python-version }}
-      - name: Install the code
-        uses: ./.github/actions/install
-        with:
-          install-target: -r requirements-dev.txt
       #cypress starts here
+      - name: Check out files needed to run cypress tests
+        if: matrix.install-variant != 'dev'
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout-cone-mode: false
+          sparse-checkout: |
+            cypress
+            package.json
+            package-lock.json
+            cypress.config.js
       - name: Install node packages
         run: npm install
       - name: Start UI
         run: npm run ui & echo "UI Server started"
-      - name: Extract server port
-        run: |
-          echo "Reading port from shared_variable.json"
-          echo 'URL='$(node -pe "require('./shared_variable.json').url") >> $GITHUB_ENV
       - name: Cypress run
         uses: cypress-io/github-action@v5
         with:
-          wait-on: ${{ env.URL }}
           wait-on-timeout: 20
           command: npm run test
           browser: chrome

idaes_ui/fv/conftest.py

@@ -0,0 +1,16 @@
+from pytest import Config
+
+
+IDAES_MARKERS = {
+    "unit": "Quick tests that do not require a solver, must run in < 2 s",
+    "component": "Quick tests that may require a solver",
+    "integration": "Long duration tests",
+}
+
+
+def pytest_configure(config: Config):
+
+    for spec, descr in IDAES_MARKERS.items():
+        config.addinivalue_line(
+            "markers", f"{spec}: {descr}"
+        )

idaes_ui/fv/tests/test_app.py

@@ -2,6 +2,8 @@
 Tests for the IDAES FV app, using FastAPI TestClient
 """
 import pytest
+
+pytest.importorskip("fastapi", reason="fastapi not available")
 from fastapi.testclient import TestClient
 from ..app import FlowsheetApp
 from idaes_ui.fv.tests.flowsheets import idaes_demo_flowsheet

idaes_ui/fv/tests/test_model_server.py

@@ -14,6 +14,7 @@
 Tests for model_server module
 """
 # stdlib
+from pathlib import Path
 # ext
 import pytest
 from pyomo.environ import ConcreteModel
@@ -27,6 +28,29 @@
 from idaes.models.unit_models import Flash
 from .test_fsvis import flash_model
 
+
+
+@pytest.fixture
+def _frontend_assets_dir() -> Path:
+    from idaes_ui.fv.model_server import _static_dir
+    return Path(_static_dir).resolve()
+
+
+@pytest.mark.unit
+@pytest.mark.parametrize(
+    "relpath",
+    [
+        "",
+        "index.html",
+        "idaes-logo.ico",
+        "data/demo_flowsheet.json",
+    ]
+)
+def test_packaged_frontend_assets(_frontend_assets_dir: Path, relpath):
+    path = _frontend_assets_dir / relpath
+    assert path.exists()
+
+
 @pytest.mark.unit
 def test_flowsheet_server_class():
     srv = model_server.FlowsheetServer()

pyproject.toml

@@ -43,7 +43,8 @@ build-backend = "setuptools.build_meta"
         # For running tests
         "pytest",
         # dependency 'requests' module for standalone idaes-ui package
-        "requests"
+        "requests",
+        "pydantic",  # idaes_ui.fv.models
     ]
     keywords = ["IDAES", "energy systems", "chemical engineering", "process modeling"]
 
@@ -93,12 +94,4 @@ idaes_ui = [
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "-ra"
-testpaths = [
-    "idaes_ui"
-]
-markers = [
-    "component: between unit and integration test",
-    "unit: test one small unit of functionality",
-    "integration: test integrated functionality"
-]
+addopts = "-ra --pyargs idaes_ui.fv"