Merge pull request #288 from glennsarti/add-gh-actions

(maint) Use GitHub actions instead of Travis and Appveyor CI

Author: jpogran

.github/workflows/create-test-matrix.ps1

@@ -0,0 +1,61 @@
+#Requires -Version 7
+param([Switch]$Raw)
+$Jobs = @()
+
+# All default OSes we test on
+$OSList =@('ubuntu-latest', 'windows-latest')
+# All default Ruby and Puppet combinations
+$RubyPuppet = @(
+  @{ ruby = '2.7'; puppet_gem_version = '~> 7.0' }
+  @{ ruby = '2.5'; puppet_gem_version = '~> 6.0' }
+  @{ ruby = '2.4'; puppet_gem_version = '~> 5.0' }
+)
+
+$OSList | ForEach-Object {
+  $OS = $_
+
+  # Add Rubocop tests
+  $Jobs += @{
+    job_name = 'Lint'
+    os = $OS
+    ruby = $RubyPuppet[0].ruby
+    puppet_gem_version = ">= 0.0"
+    rake_tasks = 'rubocop'
+  }
+
+  # Add the generic unit tests for all Ruby Puppet combinations
+  $RubyPuppet | ForEach-Object {
+    $Jobs += @{
+      job_name = 'Unit Test'
+      os = $OS
+      ruby = $_.ruby
+      puppet_gem_version = $_.puppet_gem_version
+      rake_tasks = 'gem_revendor test_languageserver test_languageserver_sidecar test_debugserver'
+    }
+  }
+
+  # Add Version specific Tests
+  $Jobs += @{
+    job_name = 'Puppet 5.1.0 Unit Test'
+    os = $OS
+    ruby = "2.4"
+    puppet_gem_version = "5.1.0"
+    rake_tasks = 'gem_revendor test_languageserver'
+  }
+
+  # Add Acceptance tests
+  $Jobs += @{
+    job_name = 'Acceptance Test'
+    os = $OS
+    ruby = $RubyPuppet[0].ruby
+    puppet_gem_version = $RubyPuppet[0].puppet_gem_version
+    rake_tasks = 'gem_revendor acceptance_languageserver'
+  }
+}
+
+if ($Raw) {
+  Write-Host ($Jobs | ConvertTo-JSON)
+} else {
+  # Output the result for consumption by GH Actions
+  Write-Host "::set-output name=matrix::$($Jobs | ConvertTo-JSON -Compress))"
+}

.github/workflows/editor-services-ci.yml

@@ -0,0 +1,91 @@
+name: Editor Services CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  matrix:
+    name: Generate test matrix
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.set-matrix.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v2
+      - id: set-matrix
+        shell: pwsh
+        # Use a small PowerShell script to generate the test matrix
+        run: "& .github/workflows/create-test-matrix.ps1"
+
+  run-tests:
+    needs: [matrix]
+    strategy:
+      fail-fast: false
+      matrix:
+        cfg: ${{ fromJson(needs.matrix.outputs.matrix) }}
+    name: "${{ matrix.cfg.job_name }} : Ruby ${{ matrix.cfg.ruby }} on ${{ matrix.cfg.os }}"
+    runs-on: ${{ matrix.cfg.os }}
+    env:
+      PUPPET_GEM_VERSION: ${{ matrix.cfg.puppet_gem_version }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.cfg.ruby }}
+          bundler-cache: true
+      - name: Update Ruby Gems
+        shell: pwsh
+        # Update rubygems to latest if it's using an old version ( < 3.x)
+        run: |
+          if ((& gem -v) -match '^(1|2)\.') {
+            Write-Host '::group::Upgrade Ruby Gems'
+            gem update --system
+            Write-Host '::endgroup'
+          } else {
+            Write-Host "No need to update rubygems"
+          }
+      - name: Test environment information
+        shell: pwsh
+        run: |
+          Write-Host '--- Ruby version'
+          & ruby -v
+          Write-Host '--- Gem version'
+          & gem -v
+          Write-Host '--- Bundler version'
+          & bundle -v
+          Write-Host '--- Gem lock file contents'
+          Get-Content Gemfile.lock -Raw
+          Write-Host '--- Puppet version'
+          & bundle exec puppet --version
+      - name: Run rake ${{ matrix.cfg.rake_tasks }}
+        # To enable debug messages for the Acceptance Tests
+        # env:
+        #   SPEC_DEBUG: 'true'
+        run: bundle exec rake ${{ matrix.cfg.rake_tasks }}
+
+  build:
+    needs: [run-tests]
+    name: "Build Editor Service"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+          bundler-cache: true
+      - name: Set build version
+        shell: pwsh
+        run: |
+          '99.99.0-gh.${{ github.run_number }}' | Out-File -FilePath 'lib\puppet_editor_services\VERSION' -Encoding ASCII -Confirm:$false -Force
+      - name: Run rake gem_revendor build
+        run: bundle exec rake gem_revendor build
+      - name: 'Upload Artifact'
+        uses: actions/upload-artifact@v2
+        with:
+          name: puppet-editor-services
+          path: output/*.zip
+          retention-days: 2

.rubocop.yml

@@ -64,9 +64,9 @@ Style/ConditionalAssignment:
 Style/Next:
   Enabled: false
 
-# Enforce LF line endings, even when on Windows
+# Line endings are just a mess
 Layout/EndOfLine:
-  EnforcedStyle: lf
+  Enabled: false
 
 # We only alias for monkey patching
 Style/Alias:

.travis.yml

@@ -327,6 +327,10 @@ def path_to_uri(path)
       expect(result['result']['dependencies']).not_to be_empty
 
       # Workspace Symbols
+      # TODO: I really don't like this. But unfortunately the workspace symbol loading is asynchronous so you don't _really_ know what it's available
+      # We could add another Request or extend puppet/getVersion to emit whether the workspace has been loaded yet.  In the meantime just sleep a long
+      # time and hope it's loaded by then.
+      sleep(15)
       @client.send_data(@client.workspace_symbols_request(@client.next_seq_id, ''))
       expect(@client).to receive_message_with_request_id_within_timeout([@client.current_seq_id, 15])
       result = @client.data_from_request_seq_id(@client.current_seq_id)