exercism_config 0.28.0 → 0.29.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 913c636d3aa6d15b8e6747b9b0e3073fee09fad61f9a198ac64e1382a4ca2da5
-  data.tar.gz: 83aac0ef0e856934a3dcf5e096b86beb2a79825493d60772ecdc6f29922995d3
+  metadata.gz: 1b04997a88ec2a910bbfd5bfc544a2283f3625303a7be4e095562c5d0426d344
+  data.tar.gz: 0b7e9976d8c8fcac075b63c19f30b7b4ff6ea1a85989b1df727cd3bac0f31a6a
 SHA512:
-  metadata.gz: 7d328e8f2334c156a54b021386e3504dc9bd92fcf5a377cb0aa67b6ef961866920dfaa47e004fbd8fbec864b910aa92cd5f2ebd961219db7e345dbca9e275338
-  data.tar.gz: '01970fc7b263be6503627d824184aaf76899efd7d1c7dfc1cbd298c5fbc638cc80ad8cdd22e2567f8486270fb890782a958ffd90a95e08de878832857a704c12'
+  metadata.gz: cc39469f3004690ae7f30069c1d31c7f9e5304774e23e7ef624da312c612a12b7e911bb43918c50b190060fea2cf3c9e002a2511d316aee2ac704e3888a8a9ed
+  data.tar.gz: 858ac021fefa6fef3fd830ebe0a2291cba521570253c45bcbdb7561cb6fa8deb3f2dcff1ec33f48610f1da08ecd0972f775a076e853b141d2a176d8e634b14df

data/.github/config/rubocop_linter_action.yml

@@ -0,0 +1,12 @@
+check_name: 'Rubocop Results'
+
+rubocop_fail_level: 'refactor'
+
+rubocop_excluded_cops:
+  - 'Metrics'
+        
+versions:
+  - rubocop
+  - rubocop-rails
+  - rubocop-minitest
+  - rubocop-performance

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: Rubocop
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Rubocop Linter Action
+      uses: andrewmcodes/rubocop-linter-action@v3.0.0
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

data/.github/workflows/tests.yml

@@ -0,0 +1,81 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      dynamodb: 
+        image: "amazon/dynamodb-local"
+        ports:
+          - 8000
+
+    steps:
+    ###
+    # Checkout using GitHub's checkout action
+    - uses: actions/checkout@v2
+
+    ###
+    # Setup Ruby - this needs to match the version in the Gemfile
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6.6
+
+    ###
+    # Caching using GitHub's caching action
+    - name: Cache Bundler
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
+    ###
+    # Install bundler and yarn dependencies
+    - name: Install dependencies
+      env:
+        EXERCISM_ENV: test
+        EXERCISM_CI: true
+        DYNAMODB_PORT: ${{ job.services.dynamodb.ports['8000'] }}
+      run: |
+        bundle config path vendor/bundle # This is needed for the caching above
+        bundle install --jobs 4 --retry 3
+        bundle exec setup_exercism_config
+
+    ###
+    # 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:
+        EXERCISM_ENV: test
+        EXERCISM_CI: true
+        DYNAMODB_PORT: ${{ job.services.dynamodb.ports['8000'] }}
+        CAPTURE_CODE_COVERAGE: true
+      run: |
+        bundle exec rake test
+        #./cc-test-reporter format-coverage -t simplecov -o codeclimate.backend.json coverage/backend/.resultset.json
+             
+    ###
+    # Publish the coverage to CodeClimate
+    # - name: Publish code coverage
+    #   env: 
+    #     GIT_BRANCH: ${GITHUB_REF/refs\/heads\//}
+    #     CC_TEST_REPORTER_ID: ${{secrets.CC_TEST_REPORTER_ID}}
+    #   run: |
+    #     ./cc-test-reporter sum-coverage codeclimate.*.json -p 2 -o codeclimate.total.json
+    #     ./cc-test-reporter upload-coverage -i codeclimate.total.json

data/.gitignore

@@ -6,5 +6,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+node_modules/
 
 exercism_config-*.gem

data/.rubocop.yml

@@ -0,0 +1,81 @@
+require:
+  - rubocop-minitest
+  - rubocop-performance
+
+AllCops:
+  NewCops: disable
+  Exclude:
+    - "bin/**/*"
+
+Bundler/OrderedGems:
+  Enabled: false
+
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/EmptyLinesAroundAccessModifier:
+  EnforcedStyle: only_before
+
+#Layout/LineLength:
+#Exclude:
+
+Lint/SuppressedException:
+  Exclude:
+    - "test/**/*"
+    - "lib/tooling_invoker/runc_wrapper.rb"
+    - "lib/tooling_invoker/external_command.rb"
+
+Metrics/BlockLength:
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  # We probably want to bring this down but let's start here for now
+  Max: 20
+  Exclude:
+    - "test/**/*"
+
+Naming/PredicateName:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Exclude:
+    - "lib/exercism_config/setup_dynamodb_client.rb"
+
+Style/NumericPredicate:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/ZeroLengthPredicate:
+  Enabled: false
+
+# I don't mind this being enabled if
+# someone fixes all the fails.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Style/LambdaCall:
+  EnforcedStyle: braces

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.6.6

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in exercism_config.gemspec
 gemspec
 
-gem "rake", "~> 12.0"
+gem 'rake', '~> 12.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exercism_config (0.21.0)
+    exercism_config (0.29.0)
       aws-sdk-dynamodb (~> 1.0)
       mandate
       zeitwerk
@@ -9,8 +9,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
     aws-eventstream (1.1.0)
-    aws-partitions (1.346.0)
+    aws-partitions (1.350.0)
     aws-sdk-core (3.104.3)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
@@ -19,24 +20,58 @@ GEM
     aws-sdk-dynamodb (1.51.0)
       aws-sdk-core (~> 3, >= 3.99.0)
       aws-sigv4 (~> 1.1)
+    aws-sdk-kms (1.36.0)
+      aws-sdk-core (~> 3, >= 3.99.0)
+      aws-sigv4 (~> 1.1)
+    aws-sdk-s3 (1.75.0)
+      aws-sdk-core (~> 3, >= 3.104.1)
+      aws-sdk-kms (~> 1)
+      aws-sigv4 (~> 1.1)
     aws-sigv4 (1.2.1)
       aws-eventstream (~> 1, >= 1.0.2)
     jmespath (1.4.0)
     mandate (0.3.0)
     minitest (5.14.1)
     mocha (1.11.2)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
     rake (12.3.3)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
+    rubocop-minitest (0.10.1)
+      rubocop (>= 0.87)
+    rubocop-performance (1.7.1)
+      rubocop (>= 0.82.0)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
     zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  aws-sdk-s3
   bundler (~> 2.1)
   exercism_config!
   minitest (~> 5.0)
   mocha
   rake (~> 12.0)
+  rubocop
+  rubocop-minitest
+  rubocop-performance
 
 BUNDLED WITH
    2.1.4

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "exercism_config"
+require 'bundler/setup'
+require 'exercism_config'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "exercism_config"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/bin/setup_exercism_config

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "exercism_config"
+require 'bundler/setup'
+require 'exercism_config'
 require 'erb'
 require 'yaml'
 
-env = ExercismConfig::DetermineEnvironment.()
+env = ExercismConfig::DetermineEnvironment.call
 if env == :production
-  puts "Aborted! This script should not be run in production."
-  exit 
+  puts 'Aborted! This script should not be run in production.'
+  exit
 end
 
 def create_table(client)
@@ -16,26 +16,26 @@ def create_table(client)
     table_name: :config,
     attribute_definitions: [
       {
-        attribute_name: "id", 
-        attribute_type: "S", 
-      },
+        attribute_name: 'id',
+        attribute_type: 'S'
+      }
     ],
     key_schema: [
       {
-        attribute_name: "id", 
-        key_type: "HASH", 
+        attribute_name: 'id',
+        key_type: 'HASH'
       }
     ],
     provisioned_throughput: {
-      read_capacity_units: 1, 
-      write_capacity_units: 1, 
+      read_capacity_units: 1,
+      write_capacity_units: 1
     }
   )
 end
 
 def delete_table(client)
   client.delete_table(
-    table_name: :config,
+    table_name: :config
   )
 end
 
@@ -49,31 +49,31 @@ def set_config_value(client, id, value)
   )
 end
 
-client = ExercismConfig::SetupDynamoDBClient.()
+client = ExercismConfig::SetupDynamoDBClient.call
 
 begin
   create_table(client)
 rescue Aws::DynamoDB::Errors::ResourceInUseException => e
-  if ARGV.include?("--force")
-    puts "Table exists. Recreating..."
+  if ARGV.include?('--force')
+    puts 'Table exists. Recreating...'
     delete_table(client)
     create_table(client)
-    puts "Table recreated."
+    puts 'Table recreated.'
   else
-    puts "Table exists. Not recreating."
+    puts 'Table exists. Not recreating.'
   end
 end
 
-settings_file_arg = ARGV.select{|arg|arg.start_with?("--settings-file=")}.first
-settings_file = 
+settings_file_arg = ARGV.select { |arg| arg.start_with?('--settings-file=') }.first
+settings_file =
   if settings_file_arg
-    settings_file_arg.split("=").last
-  elsif ENV["EXERCISM_DOCKER"]
-    File.expand_path("../../settings/docker.yml", __FILE__)
-  elsif ENV["EXERCISM_CI"]
-    File.expand_path("../../settings/ci.yml", __FILE__)
+    settings_file_arg.split('=').last
+  elsif ENV['EXERCISM_DOCKER']
+    File.expand_path('../settings/docker.yml', __dir__)
+  elsif ENV['EXERCISM_CI']
+    File.expand_path('../settings/ci.yml', __dir__)
   else
-    File.expand_path("../../settings/development.yml", __FILE__)
+    File.expand_path('../settings/development.yml', __dir__)
   end
 
 puts "Using settings file: #{settings_file}"

data/bin/setup_exercism_local_aws

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "exercism_config"
+
+# Only allow this to run in development
+return unless Exercism.environment == :development
+
+puts "Create AWS/DynamoDB tables..."
+
+Exercism.config.dynamodb_client = ExercismConfig::SetupDynamoDBClient.()
+
+##################
+# Setup local s3 #
+##################
+
+# We don't need this running for CI atm as none of our
+# tests actually hit s3. Although we might choose to change this
+unless ENV["EXERCISM_CI"]
+  begin
+    ExercismConfig::SetupS3Client.().create_bucket(bucket: Exercism.config.aws_iterations_bucket)
+  rescue Seahorse::Client::NetworkingError => e
+    puts "local S3 not up yet..."
+    sleep 2 # slighty retry delaty
+    retry
+  end
+end
+
+########################
+# Setup local dynamodb #
+########################
+%w[tooling_jobs tooling_jobs-test].each do |table_name|
+  begin
+    Exercism.config.dynamodb_client.delete_table(
+      table_name: table_name
+    )
+  rescue Aws::DynamoDB::Errors::ResourceNotFoundException
+  end
+  puts "[x] #{table_name}"
+
+  Exercism.config.dynamodb_client.create_table(
+    table_name: table_name,
+    attribute_definitions: [
+      {
+        attribute_name: "id",
+        attribute_type: "S"
+      }
+    ],
+    key_schema: [
+      {
+        attribute_name: "id",
+        key_type: "HASH"
+      }
+    ],
+    provisioned_throughput: {
+      read_capacity_units: 1,
+      write_capacity_units: 1
+    }
+  )
+
+  Exercism.config.dynamodb_client.update_table(
+    table_name: table_name,
+    attribute_definitions: [
+      {
+        attribute_name: "job_status",
+        attribute_type: "S"
+      },
+      {
+        attribute_name: "created_at",
+        attribute_type: "N"
+      }
+    ],
+    global_secondary_index_updates: [
+      {
+        create: {
+          index_name: "job_status", # required
+          key_schema: [ # required
+            {
+              attribute_name: "job_status", # required
+              key_type: "HASH" # required, accepts HASH, RANGE
+            },
+            {
+              attribute_name: "created_at", # required
+              key_type: "RANGE" # required, accepts HASH, RANGE
+            }
+          ],
+          projection: { # required
+            projection_type: "KEYS_ONLY"
+          },
+          provisioned_throughput: {
+            read_capacity_units: 1, # required
+            write_capacity_units: 1 # required
+          }
+        }
+      }
+    ]
+  )
+end