Reopening PR#5

.github/actions/build-docs/action.yml

@@ -0,0 +1,11 @@
+name: Build Sphinx docs
+description: Requires the setup-idaes action to be run before this
+# TODO add options as inputs as needed
+runs:
+  using: "composite"
+  steps:
+    - name: Build Sphinx docs (HTML)
+      shell: bash
+      run: |
+        cd docs/
+        python build.py

.github/actions/pylint/action.yml

@@ -0,0 +1,19 @@
+name: Run pylint
+description: Run static analysis using pylint
+# TODO add inputs (options) as needed
+runs:
+  using: "composite"
+  steps:
+    - name: Install pylint dependencies
+      shell: bash
+      run: |
+        PIP_INSTALL="pip --no-cache-dir install --progress-bar off"
+        $PIP_INSTALL --upgrade pip setuptools wheel
+        # TODO the pylint version will have to be pinned
+        # TODO installing idaes is necessary in our case because we import some idaes code in pylint plugins
+        $PIP_INSTALL pylint -r requirements.txt
+        # don't think we need to install the extensions, though
+    - name: Run pylint (errors only)
+      shell: bash
+      run: |
+        pylint -E --ignore-patterns="test_.*" idaes || true

.github/actions/setup-idaes/action.yml

@@ -0,0 +1,36 @@
+name: Setup 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'
+    required: true
+  install-command:
+    description: 'Command to use to install `install-target`'
+    required: false
+    default: pip --no-cache-dir install --progress-bar off
+runs:
+  using: "composite"
+  steps:
+    - name: Update pip and other packaging tools
+      shell: bash
+      run: |
+        ${{ inputs.install-command }} pip setuptools wheel
+    - name: Install idaes and dependencies
+      shell: bash
+      run: |
+        ${{ inputs.install-command }} ${{ inputs.install-target}}
+        idaes --version
+    - name: Install extensions
+      shell: bash
+      run: |
+        idaes get-extensions --verbose
+        # add bin directory to $PATH (only valid for subsequent steps)
+        echo "$(idaes bin-directory)" >> $GITHUB_PATH
+    - name: Test access to executables
+      shell: bash
+      run: |
+        if [ "$RUNNER_OS" == "Windows" ]; then
+            ipopt.exe -v
+        else
+            ipopt -v
+        fi

.github/scripts/countApproved.js

@@ -0,0 +1,32 @@
+const REVIEW_STATE = {
+  dismissed: "DISMISSED",
+  approved: "APPROVED",
+};
+
+function selectLatestPerUser(reviews) {
+  const latestByUser = {};
+  reviews.forEach((r) => {
+    // the reviews are in chronological order (earliest to latest)
+    // so to get the latest for each user we can use an Object as a map and loop over all reviews
+    // at each iteration, a more recent review for that user will replace an earlier one set before it
+    latestByUser[r.user.login] = r;
+  });
+  return Object.values(latestByUser);
+}
+
+module.exports = async ({ github, owner, repo, pullNumber }) => {
+  const { data: reviews } = await github.pulls.listReviews({
+    owner: owner,
+    repo: repo,
+    pull_number: pullNumber,
+  });
+
+  const latestReviews = selectLatestPerUser(reviews);
+  console.log(latestReviews);
+  const countApproved = latestReviews.filter(
+    (r) => r.state === REVIEW_STATE.approved
+  ).length;
+  console.log(`${countApproved} approving reviews`);
+
+  return countApproved;
+};

.github/workflows/main.yml

@@ -0,0 +1,102 @@
+name: Main
+
+on:
+  push:
+    branches:
+      # TODO this could also be run when pushing to main, but could end up clogging the CI when merging multiple PRs
+      - rel_*
+  schedule:
+    # run daily at 5:00 am UTC (12 am ET/9 pm PT)
+    - cron: '0 5 * * *'
+  repository_dispatch:
+    # to run this, send a POST API call at repos/IDAES/idaes-pse/dispatches with the specified event_type
+    # e.g. `gh repos/IDAES/idaes-pse/dispatches -F event_type=run_tests`
+    types: [run_tests]
+  workflow_dispatch:
+    inputs:
+      git-ref:
+        description: Git hash (optional)
+        required: false
+
+jobs:
+  pytest:
+    name: All tests (py${{ matrix.python-version }}/${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - '3.6'
+          - '3.7'
+        os:
+          - ubuntu-18.04
+          - windows-latest
+    steps:
+      - name: Display debug info
+        run: |
+          echo '${{ toJSON(matrix) }}'
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up idaes
+        uses: ./.github/actions/setup-idaes
+        with:
+          install-target: '.'
+      - name: Run pytest (all)
+        run: |
+          pytest
+  build-docs:
+    name: Build Sphinx docs
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Set up idaes
+        uses: ./.github/actions/setup-idaes
+        with:
+          install-target: -r requirements-dev.txt
+      - name: Build Sphinx docs
+        uses: ./.github/actions/build-docs
+      - name: Publish built docs
+        uses: actions/upload-artifact@v2
+        with:
+          name: idaes-pse-docs-html
+          path: docs/build/html/
+          retention-days: 7
+  pylint:
+    name: pylint (errors only)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Run pylint
+        uses: ./.github/actions/pylint
+  pytest-coverage:
+    name: Run pytest with coverage report
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Set up idaes
+        uses: ./.github/actions/setup-idaes
+        with:
+          install-target: -r requirements-dev.txt
+      - name: Run pytest with cov
+        run: |
+          pytest --cov
+      - name: Upload coverage report to Codecov
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: |
+          bash <(curl -s https://codecov.io/bash)

.github/workflows/pr-approved.yml

@@ -0,0 +1,68 @@
+name: PR (integration)
+
+on:
+  pull_request:
+    types: [labeled]
+
+env:
+  PR_APPROVED_LABEL_NAME: 'ci:approved'
+
+jobs:
+  check-skip:
+    name: check if integration tests should run
+    runs-on: ubuntu-latest
+    if: contains(github.event.pull_request.labels.*.name, env.PR_APPROVED_LABEL_NAME)
+    steps:
+      - name: notify
+        run: echo "The integration tests will run"
+  pytest:
+    name: Integration tests (py${{ matrix.python-version }}/${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    needs: [check-skip]
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - '3.6'
+          - '3.7'
+        os:
+          - ubuntu-18.04
+          - windows-latest
+    steps:
+      - name: Display debug info
+        run: |
+          echo '${{ toJSON(matrix) }}'
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Set up idaes
+        uses: ./.github/actions/setup-idaes
+        with:
+          install-target: '.'
+      - name: Run pytest (not integration)
+        run: |
+          pytest -m 'integration'
+  pytest-coverage:
+    name: Run pytest (complete) with coverage report
+    runs-on: ubuntu-latest
+    needs: [check-skip]
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+      - name: Set up idaes
+        uses: ./.github/actions/setup-idaes
+        with:
+          install-target: -r requirements-dev.txt
+      - name: Run pytest (complete) with cov
+        run: |
+          pytest --cov
+      - name: Upload coverage report to Codecov
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+        run: |
+          bash <(curl -s https://codecov.io/bash)