Add smoke tests (#40)

* Convert Ruby tests to smoke tests

* Fix smoke tests

* Fix build

* Update parser

* Reduce attack surface

* Simplify

* Restore tests

Author: ErikSchierboom

.dockerignore

@@ -1,4 +1,5 @@
 test/
+tests/
 scripts/
 node_modules/
 .appends
@@ -8,3 +9,6 @@ node_modules/
 .gitattributes
 .dockerignore
 Dockerfile
+bin/
+!bin/run.sh
+!bin/run.rb

.github/workflows/tests.yml

@@ -1,10 +1,12 @@
 name: Tests
 
 on:
-  push:
-    branches: [main]
   pull_request:
-    branches: [main]
+    branches:
+      - main
+  push:
+    branches:
+      - main
 
 jobs:
   test:
@@ -14,33 +16,20 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9
 
-      # Setup Ruby - this needs to match the version in the Gemfile
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@a699edbce608a2c128dedad88e3b6a0e28687b3c
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@4c0219f9ac95b02789c1075625400b2acbff50b1
         with:
-          ruby-version: 2.6.6
-          bundler-cache: true
+          install: true
 
-      # Setup code climate
-      - name: Setup Code Climate test-reporter
-        run: |
-          curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-          chmod +x ./cc-test-reporter
-          ./cc-test-reporter before-build
-
-      # Run the tests
-      - name: Run Ruby tests
-        env:
-          CAPTURE_CODE_COVERAGE: true
-        run: |
-          bundle exec rake test
-          ./cc-test-reporter format-coverage -t simplecov -o codeclimate.backend.json coverage/backend/.resultset.json
+      - name: Build Docker image and store in cache
+        uses: docker/build-push-action@2eb1c1961a95fc15694676618e422e8ba1d63825
+        with:
+          context: .
+          push: false
+          load: true
+          tags: exercism/ruby-representer
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
 
-      # Publish the coverage to CodeClimate
-      - name: Publish code coverage
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
-        env:
-          GIT_BRANCH: ${GITHUB_REF/refs\/heads\//}
-          CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
-        run: |
-          ./cc-test-reporter upload-coverage -i codeclimate.*.json
+      - name: Run Tests in Docker
+        run: bin/run-tests-in-docker.sh

.gitignore

@@ -1,4 +1,8 @@
 /fixtures/
 /tmp/
 
-node_modules
+node_modules
+
+/tests/**/representation.txt
+/tests/**/representation.json
+/tests/**/mapping.json

Dockerfile

@@ -1,10 +1,9 @@
-FROM ruby:2.5-alpine
+FROM ruby:2.6.6-alpine3.13
 
 RUN apk update && apk upgrade && \
-    apk add --no-cache bash git openssh && \
-    apk add build-base gcc wget git
+    apk add --no-cache bash git openssh build-base gcc wget git
 
-RUN gem install bundler -v 2.1.4
+RUN gem install bundler -v 2.3.6
 
 WORKDIR /opt/representer
 

bin/run-in-docker.sh

@@ -0,0 +1,48 @@
+#!/usr/bin/env sh
+set -e
+
+# Synopsis:
+# Run the representer on a solution using the representer Docker image.
+# The representer Docker image is built automatically.
+
+# Arguments:
+# $1: exercise slug
+# $2: path to solution folder
+# $3: path to output directory
+
+# Output:
+# Writes the representation to a representation.txt and representation.json file
+# in the passed-in output directory.
+# The output files are formatted according to the specifications at https://github.com/exercism/docs/blob/main/building/tooling/representers/interface.md
+
+# Example:
+# ./bin/run-in-docker.sh two-fer path/to/solution/folder/ path/to/output/directory/
+
+# Stop executing when a command returns a non-zero return code
+set -e
+
+# If any required arguments is missing, print the usage and exit
+if [ -z "$1" ] || [ -z "$2" ] || [ -z "$3" ]; then
+    echo "usage: ./bin/run-in-docker.sh exercise-slug path/to/solution/folder/ path/to/output/directory/"
+    exit 1
+fi
+
+slug="$1"
+solution_dir=$(realpath "${2%/}")
+output_dir=$(realpath "${3%/}")
+
+# Create the output directory if it doesn't exist
+mkdir -p "${output_dir}"
+
+# Build the Docker image
+docker build --rm -t exercism/ruby-representer .
+
+# Run the Docker image using the settings mimicking the production environment
+docker run \
+    --rm \
+    --network none \
+    --read-only \
+    --mount type=bind,src="${solution_dir}",dst=/solution \
+    --mount type=bind,src="${output_dir}",dst=/output \
+    --mount type=tmpfs,dst=/tmp \
+    exercism/ruby-representer "${slug}" /solution /output 

bin/run-tests-in-docker.sh

@@ -0,0 +1,32 @@
+#!/usr/bin/env sh
+set -e
+
+# Synopsis:
+# Test the representer Docker image by running it against a predefined set of 
+# solutions with an expected output.
+# The representer Docker image is built automatically.
+
+# Output:
+# Outputs the diff of the expected representation files against the actual 
+# representation files generated by the test runner Docker image.
+
+# Example:
+# ./bin/run-tests-in-docker.sh
+
+# Stop executing when a command returns a non-zero return code
+set -e
+
+# Build the Docker image
+docker build --rm -t exercism/ruby-representer .
+
+# Run the Docker image using the settings mimicking the production environment
+docker run \
+    --rm \
+    --network none \
+    --read-only \
+    --mount type=bind,src="${PWD}/tests",dst=/opt/representer/tests \
+    --mount type=tmpfs,dst=/tmp \
+    --volume "${PWD}/bin/run-tests.sh:/opt/representer/bin/run-tests.sh" \
+    --workdir /opt/representer \
+    --entrypoint /opt/representer/bin/run-tests.sh \
+    exercism/ruby-representer

bin/run-tests.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env sh
+
+# Synopsis:
+# Test the representer by running it against a predefined set of solutions 
+# with an expected output.
+
+# Output:
+# Outputs the diff of the expected representation files against the 
+# actual representation files generated by the test runner.
+
+# Example:
+# ./bin/run-tests.sh
+
+exit_code=0
+filenames="representation.txt mapping.json"
+
+# Iterate over all test directories
+for test_dir in tests/*/*; do
+    test_dir_name=$(basename "${test_dir}")
+    test_dir_path=$(realpath "${test_dir}")
+
+    bin/run.sh "${test_dir_name}" "${test_dir_path}" "${test_dir_path}"
+
+    for filename in $filenames; do
+        actual_filepath="${test_dir_path}/${filename}"
+        expected_filepath="${test_dir_path}/expected_${filename}"
+        
+        echo "${test_dir_name}: comparing ${filename} to expected_${filename}"
+        diff "${actual_filepath}" "${expected_filepath}"
+
+        if [ $? -ne 0 ]; then
+            exit_code=1
+        fi
+    done
+done
+
+exit ${exit_code}

tests/examples/basic/basic.rb

@@ -0,0 +1,5 @@
+class TwoFer
+  def two_fer
+    "foo"
+  end
+end

tests/examples/basic/expected_mapping.json

@@ -0,0 +1 @@
+{"TwoFer":"PLACEHOLDER_0","two_fer":"placeholder_1"}

tests/examples/basic/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil  (def :placeholder_1    (args)    (str "foo")))

tests/examples/lasagna/expected_mapping.json

@@ -0,0 +1 @@
+{"Lasagna":"PLACEHOLDER_0","remaining_minutes_in_oven":"placeholder_1","actual_minutes_in_oven":"placeholder_2","preparation_time_in_minutes":"placeholder_3","layers":"placeholder_4","total_time_in_minutes":"placeholder_5","number_of_layers:":"placeholder_6","actual_minutes_in_oven:":"placeholder_7"}

tests/examples/lasagna/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil  (begin    (casgn nil :EXPECTED_MINUTES_IN_OVEN      (int 40))    (casgn nil :PREPARATION_MINUTES_PER_LAYER      (int 2))    (def :placeholder_1      (args        (arg :placeholder_2))      (send        (const nil :EXPECTED_MINUTES_IN_OVEN) :-        (lvar :placeholder_2)))    (def :placeholder_3      (args        (arg :placeholder_4))      (send        (lvar :placeholder_4) :*        (const nil :PREPARATION_MINUTES_PER_LAYER)))    (def :placeholder_5      (args        (kwarg :number_of_layers)        (kwarg :placeholder_2))      (send        (send nil :placeholder_3          (lvar :number_of_layers)) :+        (lvar :placeholder_2)))))

tests/examples/lasagna/lasagna.rb

@@ -0,0 +1,16 @@
+class Lasagna
+  EXPECTED_MINUTES_IN_OVEN = 40
+  PREPARATION_MINUTES_PER_LAYER = 2
+
+  def remaining_minutes_in_oven(actual_minutes_in_oven)
+    EXPECTED_MINUTES_IN_OVEN - actual_minutes_in_oven
+  end
+
+  def preparation_time_in_minutes(layers)
+    layers * PREPARATION_MINUTES_PER_LAYER
+  end
+
+  def total_time_in_minutes(number_of_layers:, actual_minutes_in_oven:)
+    preparation_time_in_minutes(number_of_layers) + actual_minutes_in_oven
+  end
+end

tests/mapping/arguments/arguments.rb

@@ -0,0 +1,2 @@
+def somefunc(foo, bar)
+end

tests/mapping/arguments/expected_mapping.json

@@ -0,0 +1 @@
+{"somefunc":"placeholder_0","foo":"placeholder_1","bar":"placeholder_2"}

tests/mapping/arguments/expected_representation.txt

@@ -0,0 +1 @@
+(def :placeholder_0  (args    (arg :placeholder_1)    (arg :placeholder_2)) nil)

tests/mapping/attr_accessors/attr_accessors.rb

@@ -0,0 +1,6 @@
+class Foobar
+  attr_reader :foobar
+  attr_reader "other1", "other2"
+  attr_writer :barfood
+  attr_accessor :misc
+end

tests/mapping/attr_accessors/expected_mapping.json

@@ -0,0 +1 @@
+{"Foobar":"PLACEHOLDER_0","foobar":"placeholder_1","other1":"placeholder_2","other2":"placeholder_3","barfood":"placeholder_4","misc":"placeholder_5"}

tests/mapping/attr_accessors/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil  (begin    (send nil :attr_reader      (sym :foobar))    (send nil :attr_reader      (str "other1")      (str "other2"))    (send nil :attr_writer      (sym :barfood))    (send nil :attr_accessor      (sym :misc))))

tests/mapping/class/class.rb

@@ -0,0 +1,2 @@
+class Foobar
+end

tests/mapping/class/expected_mapping.json

@@ -0,0 +1 @@
+{"Foobar":"PLACEHOLDER_0"}

tests/mapping/class/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil nil)

tests/mapping/class_variables/class_variables.rb

@@ -0,0 +1,3 @@
+class Foobar
+  foobar = true
+end

tests/mapping/class_variables/expected_mapping.json

@@ -0,0 +1 @@
+{"Foobar":"PLACEHOLDER_0","foobar":"placeholder_1"}

tests/mapping/class_variables/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil  (lvasgn :placeholder_1    (true)))

tests/mapping/local_variables/expected_mapping.json

@@ -0,0 +1 @@
+{"foobar":"placeholder_0"}

tests/mapping/local_variables/expected_representation.txt

@@ -0,0 +1 @@
+(begin  (lvasgn :placeholder_0    (true))  (send nil :puts    (send nil :barfoo)))

tests/mapping/local_variables/local_variables.rb

@@ -0,0 +1,2 @@
+foobar = true
+puts barfoo

tests/mapping/method/expected_mapping.json

@@ -0,0 +1 @@
+{"Foobar":"PLACEHOLDER_0"}

tests/mapping/method/expected_representation.txt

@@ -0,0 +1 @@
+(begin  (class    (const nil :PLACEHOLDER_0) nil nil)  (const nil :BarFoo))

tests/mapping/method/method.rb

@@ -0,0 +1,3 @@
+class Foobar
+end
+BarFoo

tests/mapping/module/expected_mapping.json

@@ -0,0 +1 @@
+{"Foobar":"PLACEHOLDER_0"}

tests/mapping/module/expected_representation.txt

@@ -0,0 +1 @@
+(begin  (module    (const nil :PLACEHOLDER_0) nil)  (const nil :BarFoo))

tests/mapping/module/module.rb

@@ -0,0 +1,3 @@
+module Foobar
+end
+BarFoo

tests/naming_normalisation/args/args.rb

@@ -0,0 +1,5 @@
+foo = 1
+bar = 2
+def somefunc(param1, bar)
+  return param1 + bar
+end

tests/naming_normalisation/args/expected_mapping.json

@@ -0,0 +1 @@
+{"foo":"placeholder_0","bar":"placeholder_1","somefunc":"placeholder_2","param1":"placeholder_3"}

tests/naming_normalisation/args/expected_representation.txt

@@ -0,0 +1 @@
+(begin  (lvasgn :placeholder_0    (int 1))  (lvasgn :placeholder_1    (int 2))  (def :placeholder_2    (args      (arg :placeholder_3)      (arg :placeholder_1))    (return      (send        (lvar :placeholder_3) :+        (lvar :placeholder_1)))))

tests/naming_normalisation/class_name/class_name.rb

@@ -0,0 +1 @@
+class Foobar; end

tests/naming_normalisation/class_name/expected_mapping.json

@@ -0,0 +1 @@
+{"Foobar":"PLACEHOLDER_0"}

tests/naming_normalisation/class_name/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil nil)

tests/naming_normalisation/complex/complex.rb

@@ -0,0 +1,10 @@
+class TwoFer
+  def two_fer
+    "foo"
+  end
+
+  def foobar
+    two_fer = "cat"
+    return TwoFer.two_fer
+  end
+end

tests/naming_normalisation/complex/expected_mapping.json

@@ -0,0 +1 @@
+{"TwoFer":"PLACEHOLDER_0","two_fer":"placeholder_1","foobar":"placeholder_2"}

tests/naming_normalisation/complex/expected_representation.txt

@@ -0,0 +1 @@
+(class  (const nil :PLACEHOLDER_0) nil  (begin    (def :placeholder_1      (args)      (str "foo"))    (def :placeholder_2      (args)      (begin        (lvasgn :placeholder_1          (str "cat"))        (return          (send            (const nil :PLACEHOLDER_0) :placeholder_1))))))

tests/naming_normalisation/complex_method/complex_method.rb

@@ -0,0 +1,5 @@
+def initialize(a, b)
+  @alphabet = ('a'..'z').to_a
+  @key = [a, b]; coprime_check(key[0])
+  @cipherbet = make_cipherbet.join
+end

tests/naming_normalisation/complex_method/expected_mapping.json

@@ -0,0 +1 @@
+{"initialize":"placeholder_0","a":"placeholder_1","b":"placeholder_2","@alphabet":"@placeholder_3","@key":"@placeholder_4","@cipherbet":"@placeholder_5"}

tests/naming_normalisation/complex_method/expected_representation.txt

@@ -0,0 +1 @@
+(def :placeholder_0  (args    (arg :placeholder_1)    (arg :placeholder_2))  (begin    (ivasgn :@placeholder_3      (send        (begin          (irange            (str "a")            (str "z"))) :to_a))    (ivasgn :@placeholder_4      (array        (lvar :placeholder_1)        (lvar :placeholder_2)))    (send nil :coprime_check      (send        (send nil :key) :[]        (int 0)))    (ivasgn :@placeholder_5      (send        (send nil :make_cipherbet) :join))))

tests/naming_normalisation/global_variable/expected_mapping.json

@@ -0,0 +1 @@
+{"$foo":"$placeholder_0"}

tests/naming_normalisation/global_variable/expected_representation.txt

@@ -0,0 +1 @@
+(gvasgn :$placeholder_0  (send nil :bar))

tests/naming_normalisation/global_variable/global_variable.rb

@@ -0,0 +1 @@
+$foo = bar

tests/naming_normalisation/if/expected_mapping.json

@@ -0,0 +1 @@
+{"foo":"placeholder_0"}

tests/naming_normalisation/if/expected_representation.txt

@@ -0,0 +1 @@
+(begin  (lvasgn :placeholder_0    (true))  (if    (lvar :placeholder_0)    (str "bar")    (nil)))

tests/naming_normalisation/if/if.rb

@@ -0,0 +1 @@
+foo = true; if foo then 'bar' else nil end

tests/naming_normalisation/instance_variable/expected_mapping.json

@@ -0,0 +1 @@
+{"@foo":"@placeholder_0"}

tests/naming_normalisation/instance_variable/expected_representation.txt

@@ -0,0 +1 @@
+(ivasgn :@placeholder_0  (send nil :bar))

tests/naming_normalisation/instance_variable/instance_variable.rb

@@ -0,0 +1 @@
+@foo = bar