openstudio-ee 0.12.3 → 0.12.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df1790aecccab8862b8062bb615715fdbf51296e763148c83e1568ce4e2e97bd
-  data.tar.gz: 070f71c2a8980353452611614ce81bb1af7cf6dea524ddc0a3322b3b90e6ecb0
+  metadata.gz: 2e611eb3abfa758253b2637c0fbe2a6417af81f616aef789b080d3c59e21a921
+  data.tar.gz: 738fa87404869c4db7cfa5d3c7d6053b49b5a12e8b8228b1686b4d970367e851
 SHA512:
-  metadata.gz: 162015a8ca816b9090b0db274fc936a69e123c562d048ff30f7768ded0ed3af1405f1ac1752fa525c5231fbef6eb87656457f9e6407bb0bd1e74823fd1ed5582
-  data.tar.gz: 8c0dc4ec828cd56f98a6b855d9c875d7beb5637490f9ec0aa85c32dd74d11cc6c28c0f644ae22dc501a6aa06083a27033aefca07c4558e0cb4257cc336daa0f1
+  metadata.gz: b6f8cb5ccf030061a8033acc9f86ea09c3abd6372ef1747fda427f73041a74995d4df2d1c72ebb2f38e8891a9c05c59a2937977244902d976897de77308e115f
+  data.tar.gz: d497de4e70389ddfff91ba6a64e448b3e39aba2c123479889a2f5e63341ef03679a6bea1644037f80137a4c63d416bf116a0f72697257af7f9d417f5c980683b

data/.github/workflows/test-with-openstudio.yml

@@ -11,98 +11,133 @@ jobs:
       DEPLOY_PATH: ${{ github.repository }}/${{ github.ref_name }}/${{ github.run_number }} # Path for S3 deployment
       S3_BUCKET: ext-gem-dashboard
 
-    container: # Define the Docker container for the job. All subsequent steps run inside it.
-      image: nrel/openstudio:3.10.0
-      options: -u root -e "LANG=en_US.UTF-8" # These options are passed to the 'docker run' command internally
-
     steps:
-      - name: Checkout Repository
-        # The repository will be checked out inside the 'nrel/openstudio:3.10.0' container
-        uses: actions/checkout@v4 # Use v4 for better security and features
+      - name: Login to Docker Hub
+        # Authenticate with Docker Hub using repository secrets to access nrel/openstudio:develop
+        uses: docker/login-action@v3
         with:
-          submodules: true # Set to true if your repository uses Git submodules
-
-      - name: Install Node.js and AWS CLI
-        # Install required dependencies for AWS actions to work in the OpenStudio container
-        shell: bash
-        run: |
-          echo "Installing Node.js and AWS CLI..."
-
-          # Update package list
-          apt-get update
-
-          # Install curl and other dependencies
-          apt-get install -y curl unzip
-
-          # Install Node.js (using NodeSource repository for latest LTS)
-          curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -
-          apt-get install -y nodejs
+          username: ${{ secrets.DOCKERHUB_USERNAME }} # Ensure this secret exists in your repository or organization settings
+          password: ${{ secrets.DOCKERHUB_TOKEN }}    # Ensure this secret exists in your repository or organization settings
 
-          # Install AWS CLI v2
-          curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o "awscliv2.zip"
-          unzip awscliv2.zip
-          ./aws/install
-
-          # Verify installations
-          echo "Node.js version: $(node --version)"
-          echo "npm version: $(npm --version)"
-          echo "AWS CLI version: $(aws --version)"
+      - name: Checkout Repository
+        # Checkout the repository to the runner's workspace
+        uses: actions/checkout@v4
+        with:
+          submodules: true
 
-          # Clean up
-          rm -rf awscliv2.zip aws/
+      - name: Cache Bundle Dependencies
+        # Cache gem dependencies to speed up builds and improve reliability
+        uses: actions/cache@v4
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
 
-      - name: Verify Environment and Run Measures
-        # All 'run' commands in this job now execute inside the specified Docker container.
-        shell: bash # Specify the shell if needed, though bash is default for Ubuntu runners
+      - name: Run Tests in OpenStudio Container
+        # Run all tests inside the OpenStudio develop container with proper authentication
         run: |
-          # Fix git ownership issue in container
-          git config --global --add safe.directory /__w/openstudio-load-flexibility-measures-gem/openstudio-load-flexibility-measures-gem
+          # Pull the develop image now that we're authenticated
+          docker pull nrel/openstudio:develop
           
-          echo "OpenStudio Version: $(openstudio --version)"
-          echo "Ruby Version: $(ruby -v)"
-          echo "Listing OpenStudio Gems: $(openstudio gem_list)"
-          
-          # Install dependencies before running tests
-          echo "Installing gem dependencies..."
-          bundle install
-          
-          echo "Running spec tests..."
-          rake spec
-          echo "Running measures with verbose output:"
-          # This command will execute within the container.
-          # Ensure that './lib/measures' is the correct path relative to the checkout.
-          openstudio --verbose measure -r ./lib/measures
-
-          # The output for 'test' should now be generated directly into the workspace
-          # within the container, which is mounted from the host.
-          # No 'docker cp' is needed as the workspace is shared.
-          ls -al ./test # Verify the output directory exists and contains files
+          # Run the container with all our test commands
+          docker run --rm \
+            -u root \
+            -e "LANG=en_US.UTF-8" \
+            -v "${{ github.workspace }}:/workspace" \
+            -w /workspace \
+            nrel/openstudio:develop \
+            bash -c '
+              set -e
+              
+              echo "Starting OpenStudio EE Gem tests..."
+              echo "Ruby: $(ruby -v)"
+              echo "OpenStudio: $(openstudio openstudio_version)"
+              
+              # Fix git ownership issue in container
+              git config --global --add safe.directory "*"
+              
+              # Install system dependencies
+              apt-get update -qq
+              apt-get install -y -qq curl unzip ca-certificates
+              
+              # Install Node.js and AWS CLI (required for some tests)
+              curl -fsSL https://deb.nodesource.com/setup_20.x | DEBIAN_FRONTEND=noninteractive bash -
+              DEBIAN_FRONTEND=noninteractive apt-get install -y -qq nodejs
+              
+              curl -fsSL "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o /tmp/awscliv2.zip
+              unzip -q /tmp/awscliv2.zip -d /tmp/
+              /tmp/aws/install
+              rm -rf /tmp/aws /tmp/awscliv2.zip
+              
+              # Install gem dependencies
+              echo "Installing gem dependencies..."
+              
+              # Clean up bundler environment
+              unset BUNDLE_GEMFILE BUNDLE_PATH BUNDLE_BIN_PATH
+              
+              # Install bundler and configure
+              gem install bundler -v 2.4.10 --no-document
+              bundle config set --local path vendor/bundle
+              bundle config set --local force_ruby_platform true
+              
+              # Install gems
+              bundle install --retry 3 --jobs 4
+              
+              # Run test suite
+              echo "Running tests..."
+              bundle exec rake
+              bundle exec rake openstudio:list_measures
+              bundle exec rake openstudio:update_measures
+              bundle exec rake openstudio:test_with_openstudio
+              
+              # Archive test results
+              if [ -d "test" ]; then
+                mv test test_with_cli_bundler
+              fi
+              
+              dir_name=$(find . -type d -name "test_results" | head -1)
+              if [ -n "$dir_name" ]; then
+                mv "$dir_name" test_results_dashboard_cli_bundler
+              fi
+              
+              echo "Tests completed successfully!"
+            '
 
       - name: Configure AWS Credentials
-        # This step is crucial for authenticating with AWS S3
-        uses: aws-actions/configure-aws-credentials@v4 # Use v4 for updated features
+        # Configure AWS credentials for S3 deployment
+        uses: aws-actions/configure-aws-credentials@v4
         with:
           aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} # Assuming this is your secret name
-          aws-region: ${{ secrets.AWS_DEFAULT_REGION }} # Replace with your AWS region, e.g., us-east-1
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: ${{ secrets.AWS_DEFAULT_REGION }}
 
       - name: Sync files to S3 with branch and build in path
         shell: bash
         run: |
           echo "Deploying to s3://${{ env.S3_BUCKET }}/${{ env.DEPLOY_PATH }}/"
-          # Ensure './test_results' is the correct source directory for the files to upload to S3.
-          dir_name=$(find -type d -name "test_results")
-          # It must match the output directory from the 'Run Measures' step.
-          aws s3 sync $dir_name s3://${{ env.S3_BUCKET }}/${{ env.DEPLOY_PATH }}/ \
-            --delete \
-            --acl public-read \
-            --cache-control "max-age=0, no-cache, no-store, must-revalidate"
-          echo "S3 sync complete."
-          echo "https://${{ env.S3_BUCKET }}.s3.amazonaws.com/${{ env.DEPLOY_PATH }}/dashboard/index.html"
-          echo dir_name=$dir_name >> $GITHUB_ENV # Save the directory name to an environment variable for later use
+          # Use the renamed test_results directory
+          dir_name="test_results_dashboard_cli_bundler"
+          if [ -d "$dir_name" ]; then
+            echo "TEST_RESULTS_DIR=$dir_name" >> $GITHUB_ENV
+            if ! aws s3 sync $dir_name s3://${{ env.S3_BUCKET }}/${{ env.DEPLOY_PATH }}/ \
+              --delete \
+              --acl public-read \
+              --cache-control "max-age=0, no-cache, no-store, must-revalidate"; then
+              echo "::error::Failed to sync results to S3"
+              exit 1
+            fi
+            echo "✅ S3 sync complete."
+            echo "🌐 Dashboard URL: https://${{ env.S3_BUCKET }}.s3.amazonaws.com/${{ env.DEPLOY_PATH }}/dashboard/index.html"
+          else
+            echo "::error::Test results directory $dir_name not found"
+            echo "::error::Available directories:"
+            ls -la
+            exit 1
+          fi
 
       - name: Archive static site as artifact
         uses: actions/upload-artifact@v4
         with:
           name: static-html-artifact
-          path: ${{ env.dir_name }} # Path should be relative to the GitHub workspace, which is shared with the container          
+          path: test_results_dashboard_cli_bundler          

data/.gitignore

@@ -10,8 +10,11 @@
 /spec/reports/
 /tmp/
 /test/
+/test_results_dashboard_cli_bundler/
+/test_with_cli_bundler/
 /lib/measures/test_results
 /lib/measures/*/tests/output
+/vendor/bundle/
 
 .rubocop*s3*
 
@@ -30,3 +33,21 @@ lib/test/*
 
 # Ignore measure tester gem local test results
 test_results/
+
+lib/measures/window_enhancement/__pycache__
+lib/measures/window_enhancement/tests/__pycache__
+lib/measures/window_enhancement/resources/__pycache__
+lib/measures/window_enhancement/tests/.pytest_cache
+lib/measures/window_enhancement/tests/example_model/run
+**/__pycache__/
+config.ini
+
+# Environment variables (contains secrets)
+.env
+
+# Act secrets file
+.secrets
+
+# Act configuration file
+.actrc
+node_modules

data/.rubocop.yml

@@ -1,7 +1,20 @@
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
+  NewCops: enable
   Exclude:
     - 'spec/test_measures/**/*'
+    - 'vendor/**/*'        # Standard exclusion for all vendor code
+    - '.bundle/**/*'       # Bundler cache directory
+    - 'tmp/**/*'          # Temporary files
+    - 'node_modules/**/*' # Node.js dependencies (if applicable)
+  # Standard RuboCop behavior - these settings are actually defaults
+  DisabledByDefault: false
 
-require: rubocop-performance
+require:
+  - rubocop-performance
+  - rubocop-rake
 inherit_from:
-    - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v4.yml
+    - http://s3.amazonaws.com/openstudio-resources/styles/rubocop_v6.yml

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # OpenStudio(R) EE Gem
 
+## Version 0.12.4
+* Adding first version of window enhancement measure. This is python measure that has extra dependencies, and also requires an EC3 API key. It looks up content on EC3, stores embodied carbon data in the OpenStudio model and updates the window performance. You can not use it to only update window performance without using the EC3 database.
+
 ## Version 0.12.3
 * Update dependency for extension gem from 0.9.2 to 0.9.3
 

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec
 
@@ -10,15 +10,14 @@ gemspec
 #   Windows: set FAVOR_LOCAL_GEMS=1
 # Note that if allow_local is true, but the gem is not found locally, then it will
 # checkout the latest version (develop) from github.
-allow_local = ENV['FAVOR_LOCAL_GEMS']
+allow_local = ENV.fetch('FAVOR_LOCAL_GEMS', nil)
 
 # Delete when these branchesa are merged and released
-#gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'wenyi-fix-build-temp', ref: "34a39a24aee2259de"
-#gem 'openstudio-standards', github: 'NREL/openstudio-standards', tag: 'v0.6.0.rc2', ref: "1c42110"
-#gem 'openstudio_measure_tester', :git => 'https://github.com/NREL/OpenStudio-measure-tester-gem.git', :branch => 'wenyi-dependencies-update'
-#gem 'openstudio-workflow', :git => 'https://github.com/NREL/OpenStudio-workflow-gem.git', :branch => 'develop', ref: "32126e9b9f6"
-#gem 'bcl', :git => 'https://github.com/wenyikuang/bcl-gem.git', :branch => 'develop'
-
+# gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'wenyi-fix-build-temp', ref: "34a39a24aee2259de"
+# gem 'openstudio-standards', github: 'NREL/openstudio-standards', tag: 'v0.6.0.rc2', ref: "1c42110"
+# gem 'openstudio_measure_tester', :git => 'https://github.com/NREL/OpenStudio-measure-tester-gem.git', :branch => 'wenyi-dependencies-update'
+# gem 'openstudio-workflow', :git => 'https://github.com/NREL/OpenStudio-workflow-gem.git', :branch => 'develop', ref: "32126e9b9f6"
+# gem 'bcl', :git => 'https://github.com/wenyikuang/bcl-gem.git', :branch => 'develop'
 
 # uncomment when you want CI to use develop branch of extension gem
 # gem 'openstudio-extension', github: 'NREL/OpenStudio-extension-gem', branch: 'develop'

data/README.md

@@ -23,6 +23,7 @@ Or install it yourself as:
 
 |OpenStudio EE Gem|OpenStudio|Ruby|
 |:--------------:|:----------:|:--------:|
+| 0.12.4 | 3.10      | 3.2.2    |
 | 0.12.3 | 3.10     | 3.2.2    |
 | 0.12.2 | 3.10     | 3.2.2    |
 | 0.12.1 | 3.10     | 3.2.2    |

data/WORKFLOW_CHANGES.md

@@ -0,0 +1,74 @@
+# GitHub Actions Workflow Improvements
+
+## Overview
+This document describes the improvements made to the `.github/workflows/test-with-openstudio.yml` workflow file to enhance reliability, maintainability, and debugging capabilities.
+
+## Changes Made
+
+### 1. Docker Image Update
+- **Changed**: `nrel/openstudio:3.10.0` → `nrel/openstudio:develop`
+- **Rationale**: Access to latest features and improvements
+- **Risk**: Potential instability from using development image
+- **Mitigation**: Local testing script provided for validation
+
+### 2. Locale Configuration Fix
+- **Added**: `locales` package installation and `locale-gen en_US.UTF-8`
+- **Problem Solved**: Container was configured with `LANG=en_US.UTF-8` but locale wasn't generated
+- **Impact**: Prevents encoding issues and locale-related errors
+
+### 3. Git Configuration Correction
+- **Changed**: Fixed hardcoded repository path from `openstudio-load-flexibility-measures-gem` 
+- **New**: Uses `git config --global --add safe.directory "*"` for broader compatibility
+- **Problem Solved**: Git ownership issues in Docker container
+
+### 4. Enhanced Environment Diagnostics
+- **Added**: Bundle version information and environment details
+- **Changed**: `openstudio --version` → `openstudio openstudio_version` for more specific output
+- **Benefit**: Better debugging information in workflow logs
+
+### 5. Simplified Test Execution
+- **Removed**: Redundant double-run approach with error suppression
+- **Added**: Proper error handling with GitHub Actions error annotations
+- **Improved**: Clear success indicators with ✅ emojis
+- **Benefit**: Faster execution, clearer failure points, better debugging
+
+### 6. Robust Error Handling
+- **Added**: `::error::` annotations for GitHub Actions integration
+- **Added**: Immediate exit on critical failures
+- **Added**: Success confirmations for each step
+- **Benefit**: Clear failure identification and faster debugging
+
+### 7. Improved S3 Sync Logic
+- **Added**: Explicit error handling for S3 sync failures
+- **Added**: Directory existence validation with detailed error messages
+- **Fixed**: Environment variable handling for artifact upload
+- **Benefit**: More reliable deployment and better failure diagnostics
+
+## Testing Strategy
+
+### Local Testing
+1. Use the provided `test-workflow-locally.sh` script
+2. Validates Docker image availability and basic functionality
+3. Tests bundle install and basic rake tasks
+
+### Integration Testing
+1. Push changes to a test branch
+2. Monitor GitHub Actions execution
+3. Validate S3 deployment and artifact creation
+
+## Rollback Plan
+If issues arise with the `:develop` image:
+1. Revert to `nrel/openstudio:3.10.0`
+2. Keep all other improvements (locale, error handling, etc.)
+
+## Monitoring
+- Watch for new error patterns in GitHub Actions logs
+- Monitor S3 deployment success rates
+- Check artifact upload reliability
+
+## Benefits
+1. **Reliability**: Better error handling and clearer failure points
+2. **Debuggability**: Enhanced logging and error messages
+3. **Maintainability**: Simplified logic without redundant operations
+4. **Robustness**: Proper locale setup and git configuration
+5. **Visibility**: GitHub Actions error annotations and success indicators