generic_test 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db48df4cfd4cd3d8c19c7678a1c6055ce2d445ab6b9537762ee7376e96abe639
-  data.tar.gz: 1085e7d52b22cdd9df1b979118645bff5454bf30038335182ac20d071dccd7b9
+  metadata.gz: 5f9ac47ef59a74ef5217ab7799c57018405be18fbbe6dfce6c2c04d050353283
+  data.tar.gz: 93079f38f519161351ebcc12d5dd03a5ef07a47fdc34b2c5ff3632a0a3d0b85d
 SHA512:
-  metadata.gz: f6a91b9bde9af86eb671a9441da34f0f64bd4b3b958754f01fc77096d3906093bffb30f5500dc8b1289b9c857d219e5f538f8d1d8e6024064ddd202a72cb22c2
-  data.tar.gz: dfeeec46979ed84bb0e0c5fa8925daf6951016cc7755dafc12544b71c298e252d509e259063ec4fd8ee2bd4fc59192532aca8d337bfbe989bb8d5108657bacdb
+  metadata.gz: 625ffb51903fc52a6c9b3c07be6e03995c3674c041e90a13d2b6f8fd553a6ca9f28975d10e6d67f95e5fb7b43fb9a9ccb099ad7b6ec40bd35c53181ebeac9908
+  data.tar.gz: 458b701efb701fd57fb624451117e8006cb8365bcbfb7f53b00d75ba91af3742f7b2c239d5cc37626e8b25e71187e50eee45c50a3cc204a445435c90abbe2d10

data/.gitignore

@@ -5,6 +5,7 @@
 /doc/
 /pkg/
 /spec/reports/
+/reports/
 /tmp/
 /.idea/
 /_site/

data/.gitlab-ci.yml

@@ -8,7 +8,7 @@ docker_build:
     # Use TLS https://docs.gitlab.com/ee/ci/docker/using_docker_build.html#tls-enabled
     DOCKER_HOST: tcp://docker:2376
     DOCKER_TLS_CERTDIR: "/certs"
-  stage: build
+  stage: test
   services:
     - docker:19.03.5-dind
   image: docker:19.03.5
@@ -26,6 +26,13 @@ test:
     - gem install bundler
     - bundle install
     - bundle exec rake
+  artifacts:
+    paths:
+      - logs/*.xml
+    reports:
+      junit: logs/*.xml
+    expire_in: 1 week
+    when: always
 
 pages:
   stage: deploy

data/.rspec

@@ -1,4 +1,5 @@
 --format documentation
 --color
 --require spec_helper
---format RspecJunitFormatter --out logs/page_<%= ENV['PAGE_URL'].split('://').last %>.xml
+--format RspecJunitFormatter --out logs/page_<%= ENV['PAGE_URL'].split('://').last.tr('/', '_') %>.xml
+--format RspecHtmlReporter

data/ChangeLog

@@ -1,3 +1,13 @@
+Version 0.1.7
+* Enhancement
+  * Running generic_test exe yield correct status code on failure
+  * Add RSpec HTML report
+  * Put rest-client back in for addresses failing via Javascript
+
+Version 0.1.6
+* Enhancement
+  * Junit xml path not have subfolder for easier inclusion in test results
+
 Version 0.1.5
 * Enhancement
   * Add Junit formatter

data/Dockerfile

@@ -4,9 +4,7 @@ MAINTAINER Samuel Garratt
 # Required ruby gems
 RUN mkdir /test
 WORKDIR /test
-RUN gem install bundler generic_test
-# Should be able to be removed once gem published with dev depdencies
-RUN gem install jekyll rake
+RUN gem install generic_test
 
 # Google chrome
 ARG CHROME_VERSION="google-chrome-stable"

data/README.md

@@ -8,6 +8,10 @@ Run test gem through docker against this with
 
 `docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
 
+To get a log of your tests share a volume with the container
+
+`docker run -v "$PWD":/test -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/exe/generic_test

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require 'thor'
+require 'English'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 # Executable for Generic Test
@@ -12,9 +13,12 @@ class Exe < Thor
     test_file_path = File.join(File.dirname(__FILE__), '..', 'spec', 'generic_test_spec.rb')
     raise "no file at #{test_file_path}" unless File.exist? test_file_path
 
-    desc = ENV['PAGE_URL'].split('://').last
-    command = "rspec #{test_file_path} --format documentation --require generic_test/setup --color --format RspecJunitFormatter --out logs/page_#{desc}.xml"
-    system command
+    desc = ENV['PAGE_URL'].split('://').last.tr('/', '_')
+    junit_format = "-f RspecJunitFormatter --out logs/page_#{desc}.xml"
+    ENV['REPORT_PATH'] = "reports/#{desc}"
+    html_format = "-f RspecHtmlReporter"
+    command = "rspec #{test_file_path} --format documentation --color #{junit_format} #{html_format}"
+    raise $CHILD_STATUS.to_s unless system command
   end
 end
 

data/generic_test.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'jekyll' # For hosting test website
   spec.add_dependency 'rake'
 
+  spec.add_dependency 'rest-client'
   spec.add_dependency 'rspec'
   spec.add_dependency 'rspec_html_reporter' # Pretty HTML reports
   spec.add_dependency 'rspec_junit_formatter' # Needed for nicer reporting of rspec for use in Gitlab

data/lib/generic_test/checker.rb

@@ -1,12 +1,39 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+
 # Module for checking parts on a site
 module Checker
   class << self
+    def valid_link?(href)
+      !href.start_with?('mailto:')
+    end
+
+    # Usign Javascript fetch to retrieve URL. See https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch and
+    # https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/fetch#Parameters for details
     # @return [Integer] Status code
     def link_status(href)
-      get_js_code = "var url='#{href}'; return fetch(url).then(res=>{return res.status});"
+      init_options = "const myInit = {
+        method: 'GET',
+        credentials: 'same-origin',
+        cache: 'default',
+        mode: 'cors'
+      };"
+      get_js_code = "var url='#{href}'; #{init_options} return fetch(url, myInit).then(res=>{return res.status});"
       GenericTest.browser.execute_script get_js_code
     rescue Selenium::WebDriver::Error::JavascriptError
+      return call_via_rest_client(href) unless GenericTest.only_javascript
+
       raise GenericTest::Error, "Failed to fetch url '#{href}'"
     end
+
+    # Use rest-client to try and get status of URL
+    def call_via_rest_client(href)
+      RestClient.get(href).code
+    rescue RestClient::Exception => e
+      return e.response&.code if e.respond_to? :response
+
+      raise e
+    end
   end
 end

data/lib/generic_test/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GenericTest
-  VERSION = '0.1.5'
+  VERSION = '0.1.7'
 end

data/lib/generic_test.rb

@@ -10,10 +10,14 @@ require 'webdrivers'
 module GenericTest
   class Error < StandardError; end
   @pages = []
+  # @return [Boolean] Whether to only use Javascript. RestClient won't run in same context as
+  # browser so less likely to be accurate for logged in pages
+  @only_javascript = false
 
   class << self
     attr_accessor :browser
     attr_accessor :pages
+    attr_accessor :only_javascript
 
     def setup
       ENV['HEADLESS'] ||= 'true'

data/spec/generic_test_spec.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
+require 'generic_test/setup'
 page = GenericTest.pages.first
 links = page.links
 RSpec.describe "#{page.title} Links respond" do
   links.each_with_index do |link, index|
     next unless link.href && !link.href.empty?
 
-    it "Link (#{index + 1}) \"#{link.text}\" to '#{link.href}' responds" do
-      expect(Checker.link_status(link.href)).to be_between 200, 399
+    link_text = link.text.to_s.empty? ? '' : " \"#{link.text}\""
+    it "Link (#{index + 1})#{link_text} to '#{link.href}' succeeds" do
+      if Checker.valid_link? link.href
+        expect(Checker.link_status(link.href)).to be_between 200, 399
+      end
     end
   end
 end

data/spec/test_gem_spec.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 # Test gem works internally
 
-GenericTest.pages.each do |page|
-  links = page.links
-  RSpec.describe 'Links respond' do
-    it 'successful link passes' do
-      expect(Checker.link_status(links[0].href)).to be_between 200, 399
-    end
-    it 'broken link causes failure' do
-      expect(Checker.link_status(links[1].href)).to eq 404
-    end
+page = GenericTest.pages.first
+links = page.links
+puts links.collect(&:text)
+RSpec.describe 'Links respond' do
+  it 'successful link passes' do
+    expect(Checker.link_status(links[0].href)).to be_between 200, 399
+  end
+  it 'broken link causes failure' do
+    expect(Checker.link_status(links[1].href)).to eq 404
   end
 end

data/test_site/index.html

@@ -1,4 +1,4 @@
-<html>
+<html lang="en">
 <head>
     <title>Index</title>
 </head>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement