Merge pull request #91 from buildkite/toote_harness_scaffolding

Harness scaffolding

Author: james2791

app/lib/bk/compat/parsers/harness.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require_relative '../translator'
+require_relative '../pipeline'
+require_relative '../pipeline/step'
+require_relative 'harness/steps/run'
+
+module BK
+  module Compat
+    # Harness translation scaffolding
+    class Harness
+      include StepTranslator
+      require 'yaml'
+
+      def self.name
+        'Harness'
+      end
+
+      def self.option
+        'harness'
+      end
+
+      def self.matches?(text)
+        # sorting is important
+        config = YAML.safe_load(text, aliases: true)
+        mandatory_keys = %w[pipeline].freeze
+
+        if config.is_a?(Hash) && mandatory_keys & config.keys == mandatory_keys
+          config['pipeline'].include?('stages')
+        else
+          false
+        end
+      end
+
+      def initialize(text, options = {})
+        @config = YAML.safe_load(text, aliases: true)
+        @options = options
+
+        BK::Compat::HarnessSteps::Run.new(register: method(:register_translator))
+      end
+
+      def parse
+        # map stages to groups
+        grp = BK::Compat::GroupStep.new(
+          label: @config['pipeline']['name'],
+          key: @config['pipeline']['identifier']
+        )
+
+        grp.steps = @config['pipeline']['stages'].map do |stage|
+          parse_stage(**stage['stage'].transform_keys(&:to_sym))
+        end
+
+        Pipeline.new(steps: [simplify_group(grp)])
+      end
+
+      private
+
+      def simplify_group(group)
+        # If there ended up being only 1 stage, skip the group and just
+        # pull the steps out.
+        if group.steps.length == 1
+          group.steps.map! { |step| step.conditional = group.conditional }
+          group = groups.steps.first
+        end
+        group
+      end
+
+      def parse_stage(name:, identifier:, spec:, **_rest)
+        BK::Compat::CommandStep.new(
+          label: name,
+          key: identifier
+        ).tap do |cmd|
+          spec.dig('execution', 'steps').map do |step|
+            cmd << translate_step(**step['step'].transform_keys(&:to_sym))
+          end
+        end
+      end
+    end
+  end
+end
+
+require_relative '../parsers'
+
+BK::Compat::Parsers.register_plugin(BK::Compat::Harness)

app/lib/bk/compat/parsers/harness/steps/run.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../../../pipeline/step'
+
+module BK
+  module Compat
+    module HarnessSteps
+      # Implementation of native step translation
+      class Run
+        def initialize(register:)
+          register.call(
+            method(:matcher),
+            method(:translator)
+          )
+        end
+
+        private
+
+        def matcher(type:, **)
+          type == 'Run'
+        end
+
+        def translator(name:, identifier:, spec:, **_rest)
+          BK::Compat::CommandStep.new(
+            label: name,
+            key: identifier,
+            commands: [ spec['command'] ]
+          )
+        end
+      end
+    end
+  end
+end

app/spec/lib/bk/compat/harness/__snapshots__/spec/lib/bk/compat/harness/examples/example.yaml.snap

@@ -0,0 +1,24 @@
+---
+steps:
+- group: gha-test
+  key: ghatest
+  steps:
+  - commands:
+    - ' # step [] {:type=>"Background", :name=>"postgres-dependency", :identifier=>"postgresdependency",
+      :spec=>{"connectorRef"=>"myDockerHubConnector", "image"=>"postgres:10.8", "shell"=>"Sh",
+      "envVariables"=>{"POSTGRES_USER"=>"postgres", "POSTGRES_PASSWORD"=>"<+secrets.getValue(\"DbPasswordSecret\")>",
+      "POSTGRES_DB"=>"postgres"}}} not implemented yet :('
+    - echo "this runs on openjdk"
+    label: stage1
+    key: stage1
+  - commands:
+    - |-
+      echo "pipeline var:" <+pipeline.variables.pipelinevar1>
+      echo "project level var:" <+variable.proj_var>
+      echo "secret example :" <+secrets.getValue("DbPasswordSecret")>
+    label: stage2
+    key: stage2
+  - commands:
+    - echo "Testing on  <+matrix.testparam>"
+    label: matrix stage
+    key: matrix_stage

app/spec/lib/bk/compat/harness/examples/example.yaml

@@ -0,0 +1,110 @@
+pipeline:
+  name: gha-test
+  identifier: ghatest
+  projectIdentifier: gha_test
+  orgIdentifier: default
+  tags: {}
+  properties:
+    ci:
+      codebase:
+        connectorRef: account.myscm
+        repoName: test
+        build: <+input>
+  stages:
+    - stage:
+        name: stage1
+        identifier: stage1
+        description: ""
+        type: CI
+        spec:
+          cloneCodebase: true
+          platform:
+            os: Linux
+            arch: Amd64
+          runtime:
+            type: Cloud
+            spec: {}
+          execution:
+            steps:
+              - step:
+                  type: Background
+                  name: postgres-dependency
+                  identifier: postgresdependency
+                  spec:
+                    connectorRef: myDockerHubConnector
+                    image: postgres:10.8
+                    shell: Sh
+                    envVariables:
+                      POSTGRES_USER: postgres
+                      POSTGRES_PASSWORD: <+secrets.getValue("DbPasswordSecret")>
+                      POSTGRES_DB: postgres
+              - step:
+                  type: Run
+                  name: Run_1
+                  identifier: Run_1
+                  spec:
+                    connectorRef: myDockerHubConnector
+                    image: openjdk:17.0-jdk
+                    shell: Bash
+                    command: echo "this runs on openjdk"
+    - stage:
+        name: stage2
+        identifier: stage2
+        description: ""
+        type: CI
+        spec:
+          cloneCodebase: true
+          execution:
+            steps:
+              - step:
+                  type: Run
+                  name: Run_2
+                  identifier: Run_2
+                  spec:
+                    connectorRef: myDockerHubConnector
+                    image: node:13.0.0
+                    shell: Bash
+                    command: |-
+                      echo "pipeline var:" <+pipeline.variables.pipelinevar1>
+                      echo "project level var:" <+variable.proj_var>
+                      echo "secret example :" <+secrets.getValue("DbPasswordSecret")>
+          platform:
+            os: Linux
+            arch: Amd64
+          runtime:
+            type: Cloud
+            spec: {}
+    - stage:
+        name: matrix stage
+        identifier: matrix_stage
+        description: ""
+        type: CI
+        spec:
+          cloneCodebase: true
+          platform:
+            os: Linux
+            arch: Amd64
+          runtime:
+            type: Cloud
+            spec: {}
+          execution:
+            steps:
+              - step:
+                  type: Run
+                  name: Run_3
+                  identifier: Run_3
+                  spec:
+                    shell: Bash
+                    command: echo "Testing on  <+matrix.testparam>"
+        strategy:
+          matrix:
+            testparam:
+              - node
+              - python
+              - ubuntu
+          maxConcurrency: 3
+  variables:
+    - name: pipelinevar1
+      type: String
+      description: ""
+      value: someval

app/spec/lib/bk/compat/harness/harness_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../../../../../lib/bk/compat/parsers/harness'
+
+RSpec.describe BK::Compat::Harness do
+  let(:harness) { BK::Compat::Harness }
+
+  context 'it runs a snapshot test on each example' do
+    directory_path = 'spec/lib/bk/compat/harness/examples'
+
+    Dir.glob("#{directory_path}/*").each do |file|
+      next if File.directory?(file)
+
+      it "compares the generated pipeline for #{file} to the original" do
+        content = File.read(file)
+        parsed_content = harness.new(content).parse
+
+        actual = parsed_content.render(colors: false)
+        expect(actual).to match_snapshot(file)
+      end
+    end
+  end
+end