zspec 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f91c82c47a083a827a3e2e29ccea3fe268caa788f27a9843235b43436967ae0
+  data.tar.gz: ec4a42c998105102542fa273e8e8a3c26ca45f8b09ae70a6d543ce7d011b04a7
+SHA512:
+  metadata.gz: e9adcfcc46c6d1a0da6ff8ef7aa6168732b7b7a45b740f2e68891c58151b18549fdcdd2c1accd36724527c71d2629392a55f4ec1dfca2a9509a18a0d28a38a67
+  data.tar.gz: e54d0c1373e177135aadc41f9e43381506b9ddbde4bd0f9ad41ce307c4c5823c9971e44528275ea584083b5a009f114c8b607ad918360744ac2cd5df5ef81626

data/.drone.yml

@@ -0,0 +1,53 @@
+kind: pipeline
+name: images
+type: kubernetes
+
+steps:
+- name: bundle
+  image: ruby:2.6
+  volumes:
+  - name: ruby
+    path: /usr/local/bundle
+  commands:
+  - bundle install
+
+- name: worker
+  image: ruby:2.6
+  detach: true
+  environment:
+    ZSPEC_REDIS_HOST: redis
+    ZSPEC_REDIS_PORT: 6379
+    ZSPEC_BUILD_NUMBER: ${DRONE_BUILD_NUMBER}
+  volumes:
+  - name: ruby
+    path: /usr/local/bundle
+  commands:
+  - ./hack/worker/entrypoint.sh
+
+- name: client
+  image: ruby:2.6
+  environment:
+    ZSPEC_REDIS_HOST: redis
+    ZSPEC_REDIS_PORT: 6379
+    ZSPEC_BUILD_NUMBER: ${DRONE_BUILD_NUMBER}
+  volumes:
+  - name: ruby
+    path: /usr/local/bundle
+  commands:
+  - ./hack/client/entrypoint.sh
+
+services:
+- name: redis
+  image: redis
+  ports:
+  - 6379
+
+volumes:
+- name: ruby
+  temp: {}
+
+trigger:
+  event:
+  - pull_request
+  branch:
+  - master

data/.gitignore

@@ -0,0 +1 @@
+

data/.rspec

@@ -0,0 +1 @@
+-fd -c

data/.rubocop.yml

@@ -0,0 +1,119 @@
+AllCops:
+  ExtraDetails: true
+  TargetRubyVersion: 2.6
+
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 250
+
+Metrics/ClassLength:
+  Max: 250
+
+Metrics/MethodLength:
+  Max: 30
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+
+Metrics/CyclomaticComplexity:
+    Max: 7
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: sprintf
+
+Style/MethodDefParentheses:
+  EnforcedStyle: require_parentheses
+
+Style/NumericPredicate:
+  Enabled: false
+
+# printf style format strings are OK
+Style/FormatStringToken:
+  Enabled: false
+
+# Don't complain about using statement modifier if if blocks is 1 line long
+Style/GuardClause:
+  Enabled: false
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Layout/LeadingCommentSpace:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Layout/SpaceBeforeComment:
+  Enabled: false
+
+# Don't warn about the use of global regex variables $1, $2, etc...
+Style/PerlBackrefs:
+  Enabled: false
+
+# Don't warn about the use of global variables $:, $/, etc...
+Style/SpecialGlobalVars:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    "%w": "()"
+    "%i": "()"
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*"
+
+Style/DateTime:
+  Enabled: true
+
+Layout/ClassStructure:
+  Enabled: true
+  Categories:
+    module_inclusion:
+  ExpectedOrder:
+    - include
+    - prepend
+    - extend
+
+    - constants
+
+    - attribute
+    - attr_reader
+    - attr_writer
+    - attr_accessor
+
+    - class_methods
+    - public_methods
+    - protected_methods
+    - private_methods

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in zspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    zspec (1.0.0)
+      redis
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.4)
+    method_source (0.9.2)
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rainbow (3.0.0)
+    redis (4.1.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.0)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  pry (~> 0.12.2)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  zspec!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,33 @@
+# ZSpec
+
+ZSpec is a distributed test runner for RSpec. It consists of a `worker`, a `client`, and a `redis` store.
+
+# The Worker
+The workers are se pods running on k8s, they run `zspec work` which polls redis for work and upload the results back to redis.
+
+# The Client
+
+The client (in this case drone) queues up the specs by running `zspec queue_specs spec/ scenarios`. Then zspec kicks off the following events:
+1) calls out to rspec to get the specs to run.
+2) cleans the filepaths.
+3) orders the specs by previous runtime, longest to shortest.
+4) adds the specs to the redis queue.
+5) sets a counter with the count of specs that were added.
+
+Then the client runs `zspec present` which polls redis for completed specs, for each non-duplicate completed spec, it stores the result in memory and decrements the counter. Once the counter hits 0 it exits the loop and prints the results.
+
+![workflow](https://github.com/StreetEasy/zspec/blob/master/workflow.png "Workflow")
+
+# Having an Issue?
+
+Issue: My ZSpec build is stuck in the images state for more than 30 minutes. 
+
+Remediation:
+1) Click the Cancel button on the build in Drone
+2) Click the Restart button on the build in Drone
+
+# FAQ
+
+1) Drone provides an output of frequent flaky specs after each test run. How do I reproduce a flaky spec identified in that report?
+
+The unit of work in ZSpec is an individual spec file. Based on ZSpecs architecture, each spec file is run in isolation and not subject to possible polluted data from other files.  To reproduce a spec, run the file mentioned in the report with rspec in your local development environment.

data/bin/zspec

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../lib", __dir__)
+$:.unshift lib unless $:.include? lib
+
+require "zspec/cli"
+
+ZSpec::CLI.start

data/docker-compose.yaml

@@ -0,0 +1,41 @@
+version: "3"
+services:
+  redis:
+    image: redis
+    expose:
+    - 6379
+    volumes:
+    - redis:/data
+
+  client:
+    image: ruby:2.6
+    command: ./hack/client/entrypoint.sh
+    volumes:
+    - ./:/app
+    - bundle:/usr/local/bundle
+    depends_on:
+    - redis
+    working_dir: /app
+    environment:
+      ZSPEC_REDIS_HOST: redis
+      ZSPEC_REDIS_PORT: 6379
+      ZSPEC_BUILD_NUMBER: '1'
+
+  worker:
+    image: ruby:2.6
+    command: ./hack/worker/entrypoint.sh
+    volumes:
+    - ./:/app
+    - bundle:/usr/local/bundle
+    depends_on:
+    - redis
+    - client
+    working_dir: /app
+    environment:
+      ZSPEC_REDIS_HOST: redis
+      ZSPEC_REDIS_PORT: 6379
+      ZSPEC_BUILD_NUMBER: '1'
+
+volumes:
+  bundle:
+  redis:

data/hack/client/entrypoint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+while ! bundle exec zspec connected; do
+  echo "REDIS is unavailable - sleeping"
+  sleep 1
+done
+
+echo "Build Number: ${ZSPEC_BUILD_NUMBER}"
+
+echo "Queuing specs"
+bundle exec zspec queue_specs spec/zspec
+
+echo "Printing results"
+bundle exec zspec present

data/hack/worker/entrypoint.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+while ! bundle exec zspec connected; do
+  echo "REDIS is unavailable - sleeping"
+  sleep 1
+done
+
+echo "Build Number: ${ZSPEC_BUILD_NUMBER}"
+
+echo "Starting worker"
+bundle exec zspec work

data/lib/zspec.rb

@@ -0,0 +1,9 @@
+require "rspec/core"
+require "redis"
+require "json"
+
+module ZSpec
+  EXPIRE_SECONDS = 1800
+
+  Dir[File.join(__dir__, "zspec", "*.rb")].each { |file| require file }
+end

data/lib/zspec/cli.rb

@@ -0,0 +1,113 @@
+require "thor"
+require "zspec"
+
+module ZSpec
+  class CLI < Thor
+    desc "queue_specs", ""
+    def queue_specs(*args)
+      scheduler.schedule(args)
+    end
+
+    desc "present", ""
+    def present
+      failed = presenter.poll_results
+      queue.cleanup
+      tracker.cleanup
+      exit(1) if failed
+    end
+
+    desc "work", ""
+    def work
+      worker.work
+    end
+
+    desc "connected", ""
+    def connected
+      redis.connected?
+    end
+
+    private
+
+    def presenter
+      @presenter ||= ZSpec::Presenter.new(
+        queue: queue,
+        tracker: tracker,
+        display_count: presenter_display_count,
+        truncate_length: presenter_truncate_length
+      )
+    end
+
+    def worker
+      @worker ||= ZSpec::Worker.new(
+        queue: queue,
+        tracker: tracker
+      )
+    end
+
+    def queue
+      @queue ||= ZSpec::Queue.new(
+        sink: redis,
+        build_prefix: build_prefix,
+        timeout: queue_timeout,
+        retries: queue_retries
+      )
+    end
+
+    def tracker
+      @tracker ||= ZSpec::Tracker.new(
+        build_prefix: build_prefix,
+        threshold: tracker_threshold,
+        hostname: hostname,
+        sink: redis
+      )
+    end
+
+    def hostname
+      ENV["HOSTNAME"]
+    end
+
+    def scheduler
+      @scheduler ||= ZSpec::Scheduler.new(queue: queue, tracker: tracker)
+    end
+
+    def redis
+      @redis ||= Redis.new(host: redis_host, port: redis_port)
+    end
+
+    def build_prefix
+      "#{build_number}:queue"
+    end
+
+    def redis_host
+      ENV["ZSPEC_REDIS_HOST"]
+    end
+
+    def redis_port
+      ENV["ZSPEC_REDIS_PORT"]
+    end
+
+    def build_number
+      ENV["ZSPEC_BUILD_NUMBER"]
+    end
+
+    def queue_timeout
+      ENV["ZSPEC_QUEUE_TIMEOUT"] || 420
+    end
+
+    def queue_retries
+      ENV["ZSPEC_QUEUE_RETRIES"] || 0
+    end
+
+    def presenter_display_count
+      ENV["ZSPEC_PRESENTER_DISPLAY_COUNT"] || 25
+    end
+
+    def presenter_truncate_length
+      ENV["ZSPEC_PRESENTER_TRUNCATE_LENGTH"] || 2_000
+    end
+
+    def tracker_threshold
+      ENV["ZSPEC_TRACKER_THRESHOLD"] || 60 * 60 * 24 * 14
+    end
+  end
+end