generic_test 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6379c81a2dea26407fa5633791cb839909581636ae394a3f691e89a25a0d6c6
-  data.tar.gz: a2baae840463737782dc39a89a91b1cc34a4c865b4e1e542a9e67c647797e337
+  metadata.gz: fa5ac1b64df0509fe04187e155f7a5ea61d91abe6e69118f907128dd5debd536
+  data.tar.gz: 0d969885b9c68bc367ef7a0e2f3e57e273106fb23850247c42ca9df58af69d01
 SHA512:
-  metadata.gz: 10440d8210e40574dba8ec815443bed05a640ec3bd303f5a78ee8d035767e1c8faa03711446664083b4a2b6196b5f06b9db1e28b4477614965e3e8774b94afd6
-  data.tar.gz: ad67a5d1996580967d7deda6970a15a99cb86d96bedbb6168e5c0420c6e117bb13f62751ed14661a4cbd45f9364388bbe4a1e337ffc05da154c80cf1a8e222de
+  metadata.gz: bafdce738fd92376ee241cf140413ff55e82def63a08a26ff7288714daa424f588dce326f66729d5b7aa3647593c4c6351bc89956e7af02161553d664fa3220c
+  data.tar.gz: b0c8409d760eed8c9df56837c8b98652e7166f801faf7cb4d66abd3d520c109804e6222ec1c6b9f9ed42ff55f344937c97c36ce016e21a8af50c383126ed0be9

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,12 +18,10 @@ 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"]
-  except:
-    changes:
-      - "*.md"
+  only:
+    - master
+  needs: ["test"]
+  when: manual
 
 test:
   image: registry.gitlab.com/samuel-garratt/generic_test
@@ -51,7 +49,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,12 @@
+Version 0.3.1
+* Going through subpages goes 1 level deeper to subpages of subpages
+
+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 
 

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

@@ -12,17 +12,22 @@ class Exe < Thor
   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
+    exit(1) unless system command
+    #raise $CHILD_STATUS.to_s unless system command
   end
 
   desc 'version', 'Version of generic_test'

data/lib/generic_test/page.rb

@@ -3,8 +3,10 @@
 module GenericTest
   # Represents a web page state at a particular point of time
   class Page
-    # @return [Array] List of links
+    # @return [Array] List of links elements on the page
     attr_accessor :links
+    # @return [Array] List of urls 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:') || link.href.start_with?('tel:') }
+      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.count } links"
+end

data/lib/generic_test/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GenericTest
-  VERSION = '0.2.2'
+  VERSION = '0.3.1'
 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

@@ -3,6 +3,7 @@
 # Used by executable to verify a particular web page
 require 'generic_test/setup'
 page = GenericTest.pages.first
+checkmark = "\u2713"
 links = page.links
 RSpec.describe "#{page.title} Links respond" do
   links.each_with_index do |link, index|
@@ -10,13 +11,60 @@ 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
+  extra_subpage_links = []
+  browser = GenericTest.browser
+  page.internal_links.each do |href|
+    browser.goto href
+    sub_page = GenericTest::Page.new(browser)
+    sub_page.internal_links.each do |internal_link|
+      extra_subpage_links << internal_link unless page.internal_links.include? internal_link
+    end
+    extra_subpage_links.uniq!
+    puts "Extra subpage links #{extra_subpage_links.count}"
+    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 "#{checkmark}  Checking #{GenericTest.tested_links.count} non duplicate links"
+    end
+  end
+
+  extra_subpage_links.each do |href|
+    browser.goto href
+    sub_page = GenericTest::Page.new(browser)
+    
+    RSpec.describe "Subpage lv 2 #{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 "#{checkmark}  Checking #{GenericTest.tested_links.count} non duplicate links (lv2)"
+    end
+  end
+end
+
 emails = page.emails
 RSpec.describe "#{page.title} Emails are valid" do
   emails.each do |email|
@@ -26,17 +74,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

data/test_site/about.html

@@ -10,7 +10,8 @@
         Generic test page makes things easy
         All tests in this page work
     </p>
-    <a href="index.html">Index page</a>
+    <a href="sub_page.html">Sub page</a>
     <a href="mailto:samuel.garratt@integrationqa.com">Email me</a>
+    <a href="tel:021234567">Ignore telephone</a>
 </body>
 </html>

data/test_site/sub_page.html

@@ -0,0 +1,14 @@
+<html>
+<head>
+    <title>Sub page</title>
+</head>
+<body>
+    <header>
+        <h1>Sub page</h1>
+    </header>
+    <p>
+        This is a sub page
+    </p>
+    <a href="about.html">About</a>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.1
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-09 00:00:00.000000000 Z
+date: 2024-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -201,6 +201,7 @@ files:
 - test_site/about.html
 - test_site/index.html
 - test_site/login_page.html
+- test_site/sub_page.html
 homepage: https://gitlab.com/samuel-garratt/generic_test
 licenses:
 - MIT