generic_test 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b24968d52699e3323d8dae288b3013aa10a699f996999b9a8d5fecbd828ec415
-  data.tar.gz: ed18d73c538f5d41ba41588d4bef8019238106a1a0f578e1e4dc2c8420bf20b8
+  metadata.gz: ddd51ef58653e170a434b60dc60b963cdb38ca248ffe8c7ad5cdcb290b3ae8d4
+  data.tar.gz: e51eef767608a111aa1c119ea367ab5bf159cd072f6c4c3015cc588f2e938c46
 SHA512:
-  metadata.gz: 22fa12a82821559899257b51557b61304993c50732891577fa40cfbc8efc8a47b8bd29bfcb0b84765ab0d06208d5342427a09f2485b841466aca05f5dcb09e7b
-  data.tar.gz: 497001f35ecff93d31d44c761dc70fd30bdc95e1d4ab69a317146e2373e9db2f0947dc53d43e69ebf492d5154191d9cc7a719ad93d4997d330739d7672b8f17e
+  metadata.gz: bada0281d88dce8ec44033d833c2df8e974cda38e0040bdfc3081f5987607955591588b36f9c59a556f32f3462063798ba5dbcda2635262b606ccf285c96bc42
+  data.tar.gz: 47c446ca6abd2eabf63bf332c2918b3f13590f8ad1c4a29bbc888c965613f59effe9d539e27d8d4c9c8b1583c8186118af5bcc9dfe3a7a5f260a7c899c484cf0

data/.dockerignore

@@ -0,0 +1,2 @@
+.git/
+.git*

data/.gitlab-ci.yml

@@ -24,7 +24,7 @@ test:
   script:
     - gem install bundler
     - bundle install
-    - xvfb-run bundle exec rake
+    - bundle exec rake
 
 pages:
   stage: deploy

data/ChangeLog

@@ -0,0 +1,3 @@
+Version 0.1.1
+* Enhancement
+  * Use Javascript through Selenium to perform link checks

data/Dockerfile

@@ -2,19 +2,9 @@ FROM ruby:2.6
 MAINTAINER Samuel Garratt
 
 # Required ruby gems
-RUN mkdir /mysuite
-WORKDIR /mysuite
-COPY . /mysuite/
-RUN gem install bundler
-RUN bundle install
-# Install gem within itself
-RUN rake install
-
-# Virtual Frame buffer
-RUN apt-get update -y \
-  && apt-get -y install \
-    xvfb \
-  && rm -rf /var/lib/apt/lists/* /var/cache/apt/*
+RUN mkdir /test
+WORKDIR /test
+RUN gem install generic_test
 
 # Google chrome
 ARG CHROME_VERSION="google-chrome-stable"
@@ -29,4 +19,6 @@ RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key
 # Add language settings to handle special characters
 RUN export LANG=C.UTF-8
 RUN export LANGUAGE=C.UTF-8
-RUN export LC_ALL=C.UTF-8
+RUN export LC_ALL=C.UTF-8
+# By running test image is checked and webdriver will be cached
+RUN generic_test page samuel-garratt.gitlab.io/generic_test/about.html

data/Rakefile

@@ -12,11 +12,11 @@ directory 'logs'
 desc 'Start virtual web service'
 task start_website: :logs do
   mkdir_p 'logs'
-  command = %w[jekyll serve -s test_site]
-  ENV['test_site_pid'] = Process.spawn(*command, err: %w[logs/test_site.log w]).to_s
+  ENV['test_site_pid'] = Process.spawn('jekyll', 'serve', '-s', 'test_site',
+                                       err: %w[logs/test_site.log w]).to_s
   sleep 2 # Wait a little for virtual server to start up
   puts 'Running test site on pid ' + ENV['test_site_pid']
-  ENV['PAGE_URL'] = 'localhost:4000'
+  ENV['PAGE_URL'] = 'http://127.0.0.1:4000'
 end
 
 task default: :spec

data/exe/generic_test

@@ -4,13 +4,12 @@
 require 'thor'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 require 'generic_test'
-puts File.join(File.dirname(__FILE__), '..', 'spec')
+
 # Executable for Generic Test
 class Exe < Thor
   desc 'page page_url', 'Test web page'
   def page(page_url)
     ENV['PAGE_URL'] = page_url
-    puts ENV['PAGE_URL']
     system "cd #{File.join(File.dirname(__FILE__), '..')} && rspec spec/generic_test_spec.rb"
   end
 end

data/generic_test.gemspec

@@ -25,8 +25,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.add_dependency 'rest-client'
   spec.add_dependency 'rspec'
+  spec.add_dependency 'spellcheck'
   spec.add_dependency 'thor'  # Command line utility
   spec.add_dependency 'watir' # UI interaction
   spec.add_dependency 'webdrivers' # Download chromedriver

data/lib/generic_test.rb

@@ -3,6 +3,9 @@
 require 'generic_test/version'
 require 'generic_test/page'
 require 'generic_test/checker'
+require 'spellcheck'
+require 'watir'
+require 'webdrivers'
 
 module GenericTest
   class Error < StandardError; end

data/lib/generic_test/checker.rb

@@ -1,7 +1,12 @@
+# Module for checking parts on a site
 module Checker
   class << self
+    # @return [Integer] Status code
     def link_status(href)
-      RestClient.get(href).code
+      get_js_code = "var url='#{href}'; return fetch(url).then(res=>{return res.status});"
+      GenericTest.browser.execute_script get_js_code
+    rescue Selenium::WebDriver::Error::JavascriptError
+      raise GenericTest::Error, "Failed to fetch url '#{href}'"
     end
   end
 end

data/lib/generic_test/page.rb

@@ -1,13 +1,20 @@
 module GenericTest
+  # Represents a web page state at a particular point of time
   class Page
     # @return [Array] List of links
     attr_accessor :links
     attr_accessor :url
+    attr_accessor :html
+    attr_accessor :title
 
-    def initialize(url, links)
-      self.links = links
-      self.url = url
-      puts "Found #{links.count} links at #{url}"
+    # Store state of page when it is loaded
+    # @param [Watir::Browser] browser Watir browser
+    def initialize(browser)
+      self.links = browser.links
+      self.url = browser.url
+      self.html = browser.html
+      self.title = browser.title
+      puts "Found #{links.count} links 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.0'
+  VERSION = '0.1.1'
 end

data/spec/generic_test_spec.rb

@@ -11,4 +11,21 @@ GenericTest.pages.each do |page|
       end
     end
   end
+  RSpec.describe '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'
+      end
+      spellcheck_report.errata.group_by(&:line_number).each do |line_number, mistakes|
+        context "Line #{line_number}" do
+          mistakes.each_with_index do |mistake, index|
+            it "(#{index + 1}) #{mistake.pattern}" do
+              expect(mistake.pattern).to eq mistake.expected
+            end
+          end
+        end
+      end
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -2,9 +2,6 @@
 
 require 'bundler/setup'
 require 'generic_test'
-require 'rest-client'
-require 'watir'
-require 'webdrivers'
 
 ENV['HEADLESS'] ||= 'true'
 browser_args = %w[--disable-popup-blocking --no-sandbox --disable-dev-shm-usage]
@@ -14,9 +11,7 @@ GenericTest.browser = Watir::Browser.new :chrome, args: browser_args
 
 browser = GenericTest.browser
 browser.goto ENV['PAGE_URL']
-sleep 1
-links = browser.links
-GenericTest.pages << GenericTest::Page.new(ENV['PAGE_URL'], links)
+GenericTest.pages << GenericTest::Page.new(browser)
 
 RSpec.configure do |config|
   # Close test server after all RSpec tests have run

data/spec/test_gem_spec.rb

@@ -7,9 +7,7 @@ GenericTest.pages.each do |page|
       expect(Checker.link_status(links[0].href)).to be_between 200, 399
     end
     it 'broken link causes failure' do
-      expect do
-        Checker.link_status(links[1].href)
-      end.to raise_error RestClient::NotFound
+      expect(Checker.link_status(links[1].href)).to eq 404
     end
   end
 end

data/test_site/about.html

@@ -8,6 +8,8 @@
     </header>
     <p>
         Generic test page makes things easy
+        All tests in this page work
     </p>
+    <a href="index.html">Index page</a>
 </body>
 </html>

data/test_site/index.html

@@ -12,5 +12,24 @@
     <p id="broken_link">
         <a href="broken_link.html">Broken link</a>
     </p>
+    <p>hello world.
+
+        I create aplication now.
+
+        good bye
+
+        dokcer is great tool.
+
+        ```
+        bunlde intall ruby-build
+        ```
+
+        sample smaple
+
+        smaple sample
+
+        This is a smaple mistake
+        pakcage
+    </p>
 </body>
 </html>

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: spellcheck
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -88,6 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
@@ -106,7 +107,6 @@ files:
 - lib/generic_test/checker.rb
 - lib/generic_test/page.rb
 - lib/generic_test/version.rb
-- run.sh
 - spec/generic_test_spec.rb
 - spec/spec_helper.rb
 - spec/test_gem_spec.rb

data/run.sh

@@ -1,2 +0,0 @@
-#!/usr/bin/env bash
-xvfb-run generic_test page https://samuel-garratt.gitlab.io/generic_test