generic_test 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b1c9696f0ea835b89da12a7d1b95289955fc66097fa614009775acde222a5bd
-  data.tar.gz: 0ed1be3abda02a988dbd7befb16f4a6e725566e1a911e0c842268e371acc85f3
+  metadata.gz: ffa3efa41fd3a9b55a1ab5a258d235dbc66a1b49140e860a0dc14fa7171d1c54
+  data.tar.gz: 6661eaf0388ee25e92d75d4db9a9c9cd4c30b2a3415729fb4d5679e0661cfe78
 SHA512:
-  metadata.gz: f69e2f461c62fcd4be622afbc3754197c6731d8d650aeffd5727f80514237aa136d347a131f94c6ab889f1ae3a62d5e9aad010eeff917932eefc04bf2be7715e
-  data.tar.gz: ae3bd8b8c02e3d269b55916482098a6dd3b86ef8e05ebb7a1aecb117f09d0e19a0b49d8233f8b393832d357f153fcc4ca3f846a589c3865eb5b9fe24927e1950
+  metadata.gz: 430e5e3e718cffbf314033ae023382f160f7abb6f3ac81bba0de0abac0cc084ce784484c94707aa048c2f9486fd6c248eb51eeda73f011f25a246caa42647bca
+  data.tar.gz: bcdaa788d1a6148c836de1785c45340dcb9a15608573590eca035915c9fa7eed4003d46f060c750e241d3d06fa051f98ec42293f8f4834665208f99241e9ecfe

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: test # Part of a later stage
+  stage: deploy # Part of a later stage
   services:
     - docker:20.10.11-dind
   image: docker:20.10.11
@@ -18,9 +18,9 @@ docker_build:
     - 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
-  # only:
-  #   - master
-  # needs: ["test"]
+  only:
+    - master
+  needs: ["test"]
   except:
     changes:
       - "*.md"
@@ -51,7 +51,7 @@ example_test:
   artifacts:
     paths:
       - logs/*.xml
-      - reports
+      - logs/*.html
     reports:
       junit: logs/*.xml
     expire_in: 1 week

data/.rspec

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

data/ChangeLog

@@ -1,3 +1,15 @@
+Version 0.3.0
+* Added option to test all subpages and skip spellcheck
+
+Version 0.2.3
+* Put HTML report into logs folder and mention sourcing it
+
+Version 0.2.2
+* Ignore telephone numbers in links 
+
+Version 0.2.1
+* Get working with Ruby 3.3
+
 Version 0.1.13
 * Enhancement
   * Fail if cannot find url of page provided

data/Dockerfile

@@ -22,5 +22,3 @@ RUN export LANGUAGE=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
-
-ENTRYPOINT ["generic_test", "page"]

data/README.md

@@ -16,6 +16,18 @@ To get a log of your tests share a volume with the container.
 
 > Please share this volume from an empty folder. Running from within another gem might cause an issue
 
+To test test links on all subpages of a site add `--all-subpages` to the command. 
+
+To test without performing spellchecking of common spelling add `--no-spellcheck`
+
+E.g
+
+`docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test --all-subpages --no-spellcheck`
+
+You can see all options by running
+
+`docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test help page`
+
 ## Add to gitlab CI for your website
 
 Add the following `YAML` to test against a website
@@ -30,7 +42,7 @@ example_test:
   artifacts:
     paths:
       - logs/*.xml
-      - reports # HTML reports
+      - logs/*.html # HTML reports
     reports:
       junit: logs/*.xml
     expire_in: 1 week

data/exe/generic_test

@@ -7,16 +7,24 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 # Executable for Generic Test
 class Exe < Thor
+  def self.exit_on_failure?
+    true
+  end
+
   desc 'page page_url', 'Test web page'
+  method_options all_subpages: false
+  method_options spellcheck: true
   def page(page_url)
     ENV['PAGE_URL'] = page_url
+    ENV['ALL_SUBPAGES'] ||= options.all_subpages?.to_s
+    ENV['SPELLCHECK_ON'] = options.spellcheck?.to_s
     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.tr('/', '_')
     junit_format = "-f RspecJunitFormatter --out logs/page_#{desc}.xml"
     ENV['REPORT_PATH'] = "reports/#{desc}"
-    html_format = '--format html --out report.html'
+    html_format = '--format html --out logs/report.html'
     command = "rspec #{test_file_path} --format documentation --color #{junit_format} #{html_format}"
     raise $CHILD_STATUS.to_s unless system command
   end

data/lib/generic_test/page.rb

@@ -5,6 +5,8 @@ module GenericTest
   class Page
     # @return [Array] List of links
     attr_accessor :links
+    # @return [Array] List of links that include domain being tested
+    attr_accessor :internal_links
     # @return [Array] List of emails
     attr_accessor :emails
     attr_accessor :url
@@ -18,8 +20,11 @@ module GenericTest
       self.emails, self.links = browser.links.partition do |link|
         link.href.start_with?('mailto:')
       end
-      links.reject! { |link| link.href.empty? || link.href.start_with?('javascript:') }
+      links.reject! { |link| link.href.empty? || link.href.start_with?('javascript:') || link.href.include?('tel:') }
       emails.collect! { |link| link.href.split(':').last }
+      self.internal_links = links.filter do |link|
+        link.href.include? ENV["PAGE_URL"]  
+      end.collect { |link| link.href  }.uniq
       self.url = browser.url
       self.html = browser.html
       self.text = browser.text

data/lib/generic_test/setup.rb

@@ -34,8 +34,13 @@ if ENV[GT_LOGIN_URL] && ENV[GT_USERNAME] && ENV[GT_PASSWORD]
   puts "Login through #{ENV[GT_LOGIN_URL]} successful!"
 end
 
+GenericTest.all_subpages = true if ENV['ALL_SUBPAGES'] == 'true'
 ENV['PAGE_URL'] = RestClient.get(ENV['PAGE_URL']).request.url # Check page exists
-puts "Checking #{ENV['PAGE_URL']}"
+puts "Loading..."
 browser.goto ENV['PAGE_URL']
 sleep 2.5 # Give a bit of time for page to load
+puts "Checking #{ENV['PAGE_URL']} (#{browser.title})"
 GenericTest.pages << GenericTest::Page.new(browser)
+if GenericTest.all_subpages
+  puts "Subpages include #{GenericTest.pages.first.internal_links }"
+end

data/lib/generic_test/version.rb

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

data/lib/generic_test.rb

@@ -19,7 +19,10 @@ module GenericTest
     attr_accessor :browser
     attr_accessor :pages
     attr_accessor :tested_links
+    # @return [Boolean]
     attr_accessor :only_javascript
+    # @return [Boolean] Whether to check all subpages of initial page
+    attr_accessor :all_subpages
   end
 end
 

data/spec/generic_test_spec.rb

@@ -10,13 +10,35 @@ RSpec.describe "#{page.title} Links respond" do
     next if GenericTest.tested_links.include? link.href
 
     GenericTest.tested_links << link.href
-    it "Link (#{index + 1})#{link_text} to '#{link.href}' succeeds" do
-      expect(Checker.link_status(link.href)).to be_between 200, 399
+    link_href = link.href
+    it "Link (#{GenericTest.tested_links.count})#{link_text} to '#{link.href}' succeeds" do
+      expect(Checker.link_status(link_href)).to be_between 200, 399
     end
   end
   puts "Checking #{GenericTest.tested_links.count} non duplicate links"
 end
 
+if GenericTest.all_subpages
+  browser = GenericTest.browser
+  page.internal_links.each do |href|
+    browser.goto href
+    sub_page = GenericTest::Page.new(browser)
+    RSpec.describe "Subpage #{browser.title} #{href}" do
+      sub_page.links.each_with_index do |link, index|
+        link_text = link.text.to_s.empty? ? '' : " \"#{link.text}\""
+        next if GenericTest.tested_links.include? link.href
+
+        GenericTest.tested_links << link.href
+        link_href = link.href
+        it "Link (#{GenericTest.tested_links.count})#{link_text} to '#{link.href}' succeeds" do
+          expect(Checker.link_status(link_href)).to be_between 200, 399
+        end
+      end
+      puts "Checking #{GenericTest.tested_links.count} non duplicate links"
+    end
+  end
+end
+
 emails = page.emails
 RSpec.describe "#{page.title} Emails are valid" do
   emails.each do |email|
@@ -26,17 +48,19 @@ RSpec.describe "#{page.title} Emails are valid" do
   end
 end
 
-RSpec.describe "#{page.title} Page content" do
-  spellcheck_report = SpellCheck::ProofReader.check(page.text)
-  context 'does not have common spelling mistakes' do
-    it 'has no mistakes' do
-      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
-        mistakes.each_with_index do |mistake, index|
-          it "(#{index + 1}) #{mistake.pattern}" do
-            expect(mistake.pattern).to eq mistake.expected
+if ENV['SPELLCHECK_ON'] == 'true'
+  RSpec.describe "#{page.title} Page content spelling" do
+    spellcheck_report = SpellCheck::ProofReader.check(page.text)
+    context 'does not have common spelling mistakes' do
+      it 'has no mistakes' do
+        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
+          mistakes.each_with_index do |mistake, index|
+            it "(#{index + 1}) #{mistake.pattern}" do
+              expect(mistake.pattern).to eq mistake.expected
+            end
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-09 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll