generic_test 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 240386cd484ae65d67e46c29f9534eb17bc88f5e198bfabf34b689babad38038
-  data.tar.gz: 76c74899bef89a6a2cd856d6b6e1f4db154443f09427fa7c259e9a3f602b0410
+  metadata.gz: 3cd6c9a3fb72be1be7624ef067e5240d37cd95607a62f1a18214de73e589be63
+  data.tar.gz: ee175d1814512d5dfb07582dd733e06525e7b3c324c42a9922e6eb50cf69b33f
 SHA512:
-  metadata.gz: 710883182d9f0aaa0d81f19f744edfd1b8abadb9e703ac7c53235464046f5b8c53044e7fd4ba211471963a2ec8732511d44b1b7a67daea17296342aac8a44a76
-  data.tar.gz: '0093ddc398d3101d2957fa9c883e3a97e52b3730e59b33f8592042c1c345a44f10c067a96e14dd5ce7c406bff63436f77ce72375be30d96b4d3b64b04b2cf8c8'
+  metadata.gz: 8c6f165cba804d210657ef544a83da5de6bb21b664ea446b18f87ba817b0fdcc29ca80883518427a1ffc5b3ea4117271ecf65290bbdb0134115657577da373d3
+  data.tar.gz: a960a256ecbd5d8c951458936323c8e8a55ef5c4855a614f21fa29adda402b191e265adfe3de7ba62700568ee831bee9b3c2ba92efd9be2e1b90b24a8620ecd8

data/.gitlab-ci.yml

@@ -8,13 +8,13 @@ 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: test
+  stage: deploy # Part of a later stage
   services:
     - docker:19.03.5-dind
   image: docker:19.03.5
   script:
     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
-    - docker pull $CI_REGISTRY_IMAGE:latest || true
+    - docker pull --quiet $CI_REGISTRY_IMAGE:latest || true
     - docker build -t $CI_REGISTRY_IMAGE:latest .
     - docker run -t $CI_REGISTRY_IMAGE:latest generic_test page samuel-garratt.gitlab.io/generic_test/about.html
     - docker push $CI_REGISTRY_IMAGE:latest

data/ChangeLog

@@ -1,6 +1,11 @@
+Version 0.1.10
+* Bug fix
+  * Add custom file implementing mock of what's needed for RSpecHtmlReporter
+  * Split email addresses into separate list and add validation for them using 'email_address' gem
+
 Version 0.1.9
 * Bug fix
-  * rspec-legacy_formatters now needed for RSpecHtmlFormatter
+  * rspec-legacy_formatters will be needed for RSpecHtmlFormatter
 
 Version 0.1.8
 * Bug fix

data/Dockerfile

@@ -4,7 +4,7 @@ MAINTAINER Samuel Garratt
 # Required ruby gems
 RUN mkdir /test
 WORKDIR /test
-RUN gem install generic_test
+RUN gem install bundler generic_test
 
 # Google chrome
 ARG CHROME_VERSION="google-chrome-stable"

data/README.md

@@ -4,7 +4,7 @@ This gem provides an easy way to run generic tests for a website/api
 
 Test site is at https://samuel-garratt.gitlab.io/generic_test
 
-Run test gem through docker against this with
+Run test gem through docker against this website with (Note it is an example that has some failures)
 
 `docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
 

data/exe/generic_test

@@ -16,10 +16,16 @@ class Exe < Thor
     desc = ENV['PAGE_URL'].split('://').last.tr('/', '_')
     junit_format = "-f RspecJunitFormatter --out logs/page_#{desc}.xml"
     ENV['REPORT_PATH'] = "reports/#{desc}"
-    html_format = '--require rspec_html_reporter -f RspecHtmlReporter'
+    html_format = '--require generic_test/html_reporter -f RspecHtmlReporter'
     command = "rspec #{test_file_path} --format documentation --color #{junit_format} #{html_format}"
     raise $CHILD_STATUS.to_s unless system command
   end
+
+  desc 'version', 'Version of generic_test'
+  def version
+    require 'generic_test'
+    puts "GenericTest version #{GenericTest::VERSION}"
+  end
 end
 
 Exe.start(ARGV)

data/generic_test.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = 'https://gitlab.com/samuel-garratt/generic_test'
-  spec.metadata['changelog_uri'] = 'https://gitlab.com/samuel-garratt/soaspec/blob/master/ChangeLog'
+  spec.metadata['changelog_uri'] = 'https://gitlab.com/samuel-garratt/generic_test/blob/master/ChangeLog'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -27,15 +27,17 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   # Development dependencies are installed too since running external tests within gem
   spec.add_development_dependency 'jekyll' # For hosting test website
-  spec.add_dependency 'rake'
-
-  spec.add_dependency 'rest-client'
-  spec.add_dependency 'rspec'
+  spec.add_development_dependency 'rake'
   spec.add_dependency 'rspec-legacy_formatters' # Needed for rspec_html_reporter after RSpec 3
-  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
-  spec.add_dependency 'spellcheck'
-  spec.add_dependency 'thor'  # Command line utility
-  spec.add_dependency 'watir' # UI interaction
-  spec.add_dependency 'webdrivers' # Download chromedriver
+  spec.add_dependency 'rspec_html_reporter'   # Pretty HTML reports
+  spec.add_dependency 'rspec_junit_formatter' # Needed for nicer reporting of rspec for use in CI
+  spec.add_dependency 'simplecov'     # Code coverage
+
+  spec.add_dependency 'email_address' # Verify email address
+  spec.add_dependency 'rest-client'   # Verify links
+  spec.add_dependency 'rspec'         # Test framework
+  spec.add_dependency 'spellcheck'    # Check for common spelling errors
+  spec.add_dependency 'thor'          # Command line utility
+  spec.add_dependency 'watir'         # UI interaction
+  spec.add_dependency 'webdrivers'    # Download chromedriver automatically
 end

data/lib/generic_test/checker.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
 require 'rest-client'
+require 'email_address'
 
 # 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
+    # Using 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)
+      return unless href
+
       init_options = "const myInit = {
         method: 'GET',
         credentials: 'same-origin',
@@ -27,6 +26,11 @@ module Checker
       raise GenericTest::Error, "Failed to fetch url '#{href}'"
     end
 
+    # @return [Nil, String] Nil if valid, string if error
+    def valid_email?(email_address)
+      EmailAddress.error email_address
+    end
+
     # Use rest-client to try and get status of URL
     def call_via_rest_client(href)
       RestClient.get(href).code

data/lib/generic_test/html_reporter.rb

@@ -0,0 +1,11 @@
+# Mock implementation of Bundler for use by generic_test where Bundler.root is needed
+module Bundler
+  class << self
+    # Used just so that RSpecHtmlReporter does not thrown an error
+    def root
+      ''
+    end
+  end
+end
+
+require 'rspec_html_reporter'

data/lib/generic_test/page.rb

@@ -3,6 +3,8 @@ module GenericTest
   class Page
     # @return [Array] List of links
     attr_accessor :links
+    # @return [Array] List of emails
+    attr_accessor :emails
     attr_accessor :url
     attr_accessor :html
     attr_accessor :title
@@ -10,11 +12,15 @@ module GenericTest
     # Store state of page when it is loaded
     # @param [Watir::Browser] browser Watir browser
     def initialize(browser)
-      self.links = browser.links
+      self.emails, self.links = browser.links.partition do |link|
+        link.href.start_with?('mailto:')
+      end
+      links.reject! { |link| link.href.empty? }
+      emails.collect! { |link| link.href.split(':').last }
       self.url = browser.url
       self.html = browser.html
       self.title = browser.title
-      puts "Found #{links.count} links at #{url} (#{title})"
+      puts "Found #{links.count} links, #{emails.count} emails at #{url} (#{title})"
     end
   end
 end

data/lib/generic_test/version.rb

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

data/spec/generic_test_spec.rb

@@ -1,25 +1,32 @@
 # frozen_string_literal: true
 
+# Used by executable to verify a particular web page
 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?
-
     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
+      expect(Checker.link_status(link.href)).to be_between 200, 399
     end
   end
 end
+
+emails = page.emails
+RSpec.describe "#{page.title} Emails are valid" do
+  emails.each do |email|
+    it "Email (#{email}) is valid" do
+      expect(Checker.valid_email?(email)).to be nil
+    end
+  end
+end
+
 RSpec.describe "#{page.title} Page content" do
   spellcheck_report = SpellCheck::ProofReader.check(page.html)
   context 'does not have common spelling mistakes' do
     it 'has no mistakes' do
-      expect(spellcheck_report.status).to eq 'Accept'
+      expect(spellcheck_report.errata.size).to eq 0
     end
     spellcheck_report.errata.group_by(&:line_number).each do |line_number, mistakes|
       context "Line #{line_number}" do

data/spec/spec_helper.rb

@@ -1,6 +1,16 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+SimpleCov.at_exit do
+  SimpleCov.result.format!
+  SimpleCov.minimum_coverage 85
+end
+
 require 'generic_test/setup'
 
 RSpec.configure do |config|

data/spec/test_gem_spec.rb

@@ -1,15 +1,37 @@
 # frozen_string_literal: true
 
-# Test gem works internally
+# Test gem works
 
 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
+
+RSpec.describe 'Links' do
+  it 'counts correctly (not include )' do
+    expect(links.size).to eq 3
+  end
+  context 'successful' do
+    it 'external page' do
+      expect(Checker.link_status(links[0].href)).to be_between 200, 399
+    end
+    it 'internal link' do
+      expect(Checker.link_status(links[2].href)).to be_between 200, 399
+    end
   end
-  it 'broken link causes failure' do
+  it 'broken causes failure' do
     expect(Checker.link_status(links[1].href)).to eq 404
   end
 end
+puts page.emails
+RSpec.describe 'Emails' do
+  it 'counts correctly' do
+    expect(page.emails.size).to eq 2
+  end
+  context 'validate' do
+    it 'accepts valid email' do
+      expect(Checker.valid_email?(page.emails[0])).to be nil
+    end
+    it 'returns invalid email error' do
+      expect(Checker.valid_email?(page.emails[1])).to eq 'Domain name not registered'
+    end
+  end
+end

data/test_site/index.html

@@ -12,6 +12,12 @@
     <p id="broken_link">
         <a href="broken_link.html">Broken link</a>
     </p>
+    <h2><a id="special_links"></a> Special links</h2>
+    <p>
+        <a href="mailto:samuel.garratt@integrationqa.com">Email me</a>
+        <a href="#special_links">Link to heading</a>
+        <a href="mailto:invalid.person@bad-d0main.com">Don't try to email this</a>
+    </p>
     <p>hello world.
 
         I create aplication now.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-17 00:00:00.000000000 Z
+date: 2020-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -26,6 +26,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-legacy_formatters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rspec_html_reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec-legacy_formatters
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_html_reporter
+  name: email_address
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +109,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  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
     requirements:
     - - ">="
@@ -189,6 +217,7 @@ files:
 - generic_test.gemspec
 - lib/generic_test.rb
 - lib/generic_test/checker.rb
+- lib/generic_test/html_reporter.rb
 - lib/generic_test/page.rb
 - lib/generic_test/setup.rb
 - lib/generic_test/version.rb
@@ -203,7 +232,7 @@ licenses:
 metadata:
   homepage_uri: https://gitlab.com/samuel-garratt/generic_test
   source_code_uri: https://gitlab.com/samuel-garratt/generic_test
-  changelog_uri: https://gitlab.com/samuel-garratt/soaspec/blob/master/ChangeLog
+  changelog_uri: https://gitlab.com/samuel-garratt/generic_test/blob/master/ChangeLog
 post_install_message: 
 rdoc_options: []
 require_paths: