generic_test 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e9dabdf7bdc04b3967c77b109f7ce9ee0893896c31d98c05f54a732e9d7f513
-  data.tar.gz: 715dc1bb7195c5dfb5eab9d5da467fdbbd5d54c431151876397141ed4bed9cbb
+  metadata.gz: 5511c72398002fc4468de6f4e1e6a3f8c27783fd2cbeef28decae9a833698f57
+  data.tar.gz: 4aaad3513df4be30725c97ac25fd07bc052bc90dac9b7270d286c1f5ce017090
 SHA512:
-  metadata.gz: ce37d41116ea08457eeb93d247b517f834d7cc790c1bd43b21457f16cc221af8f82d3cc3d8093aff30682237d0d120e36ab407ef56e0fcbbbcb9a166f6777b4c
-  data.tar.gz: 4769b1befffe34c5798bf485bc1ff717b86b50f8cb5d26e145d43251ed1f84c737d50dba925df7d76953e7f11e2115588fbebb962097b5c74cd6536253af590c
+  metadata.gz: 4848379d61b1064629f36ca3861759a564ee2fe4d156afb235c6a1eddce86dfd14b05980b6d45dec81b46404d5ce27b81a78fe2f25372ac2040bc5ac480283fe
+  data.tar.gz: 5c92f007d44d6bcfc74113c091c2fab49a1266c1eef09b093220660eeb2d3db34424f3663f0b752e3c01660df1b8699459954aac88e21e013cf84916f8717370

data/ChangeLog

@@ -1,3 +1,7 @@
+Version 0.1.12
+* Enhancement
+  * More generic matching of username labels allowing any case to be used
+
 Version 0.1.11
 * Enhancement
   * Spell check based on text of page, not HTML.

data/README.md

@@ -8,10 +8,12 @@ Run test gem through docker against this website with (Note it is an example tha
 
 `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
+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`
 
+> Please share this volume from an empty folder. Running from within another gem might cause an issue
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -33,14 +35,45 @@ Or install it yourself as:
 ### Running locally. 
 
 Use the executable `generic_test`, add the page command and put a website to check:
+
+`generic_test page URL_OF_WEBSITE` 
+
+E.g.,
+
 `generic_test page samuel-garratt.gitlab.io/generic_test` 
 
 ### Run with docker
 
-docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page URL
+`docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page URL_OF_WEBSITE`
 
 `docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
 
+### Through login page
+
+Environment variables store Login URL, username and password
+* GT_LOGIN_URL: Url to login at
+* GT_USERNAME: Username to use
+* GT_PASSWORD: Password to use
+
+At the moment Generic test tries to be smart to identify the username, password and submit elements. In
+the future, option will be given to provide your own identifiers if this does not work.
+
+These variables can be set in `docker run` 
+
+`docker run -e "GT_LOGIN_URL=samuel-garratt.gitlab.io/generic_test/login_page" -e "GT_USERNAME=Tester" -e "GT_PASSWORD=Pass" -v "$PWD":/test -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
+
+These variables can also be set in a `.generic_test.page.yml` (you will need a volume to have this available to
+docker container)
+
+E.g., file to login as above:
+
+```yaml
+login:
+  url: 'samuel-garratt.gitlab.io/generic_test/login_page'
+  username: 'Tester'
+  password: 'Pass'
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -4,20 +4,23 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(spec: :start_website) do |task|
-  task.pattern = 'spec/test_gem_spec.rb'
+  task.pattern = 'spec/test_gem/*spec.rb'
 end
 
 directory 'logs'
 
 desc 'Start virtual web service'
 task start_website: :logs do
+  require 'generic_test'
   mkdir_p 'logs'
   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'] = 'http://127.0.0.1:4000'
-  ENV['PAGE_NUM'] = '1'
+  ENV[GT_USERNAME] = 'Test User'
+  ENV[GT_PASSWORD] = 'Test Password'
+  ENV[GT_LOGIN_URL] = 'http://127.0.0.1:4000/login_page.html'
 end
 
 task default: :spec

data/exe/generic_test

@@ -28,4 +28,4 @@ class Exe < Thor
   end
 end
 
-Exe.start(ARGV)
+Exe.start(ARGV)

data/lib/generic_test.rb

@@ -7,6 +7,7 @@ require 'spellcheck'
 require 'watir'
 require 'webdrivers'
 
+# Handles testing of sites generically for common issues
 module GenericTest
   class Error < StandardError; end
   @pages = []
@@ -20,3 +21,10 @@ module GenericTest
     attr_accessor :only_javascript
   end
 end
+
+# @return [String] Generic Test URL to login before arriving at PAGE_URL to test.
+#   Needs GT_USERNAME and GT_PASSWORD to be used
+GT_LOGIN_URL = 'GT_LOGIN_URL'
+GT_USERNAME = 'GT_USERNAME'
+GT_PASSWORD = 'GT_PASSWORD'
+GT_PAGE_SETTING_FILE = 'generic_test.page.yml'

data/lib/generic_test/html_reporter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Mock implementation of Bundler for use by generic_test where Bundler.root is needed
 module Bundler
   class << self
@@ -8,4 +10,4 @@ module Bundler
   end
 end
 
-require 'rspec_html_reporter'
+require 'rspec_html_reporter'

data/lib/generic_test/page.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GenericTest
   # Represents a web page state at a particular point of time
   class Page

data/lib/generic_test/setup.rb

@@ -2,13 +2,7 @@
 
 # One file to require gem and set things up, arriving at page to check
 require 'generic_test'
-
-# @return [String] Generic Test URL to login before arriving at PAGE_URL to test.
-#   Needs GT_USERNAME and GT_PASSWORD to be used
-GT_LOGIN_URL = 'GT_LOGIN_URL'
-GT_USERNAME = 'GT_USERNAME'
-GT_PASSWORD = 'GT_PASSWORD'
-GT_PAGE_SETTING_FILE = 'generic_test.page.yml'
+require_relative 'xpath'
 
 ENV['HEADLESS'] ||= 'true'
 ENV['PAGE_NUM'] ||= '1'
@@ -32,8 +26,8 @@ end
 browser = GenericTest.browser
 if ENV[GT_LOGIN_URL] && ENV[GT_USERNAME] && ENV[GT_PASSWORD]
   browser.goto ENV[GT_LOGIN_URL]
-  browser.text_field(xpath: "//input[@id=(//label[text()='Username']/@for)]|//input[@*='username']").set ENV[GT_USERNAME]
-  browser.text_field(xpath: "//input[@id=(//label[text()='Password']/@for)]|//input[@*='password']").set ENV[GT_PASSWORD]
+  browser.text_field(xpath: Xpath.label_or_attribute('username')).set ENV[GT_USERNAME]
+  browser.text_field(xpath: Xpath.label_or_attribute('password')).set ENV[GT_PASSWORD]
   login_button = browser.button(xpath: "//*[@type='submit']|//*[@*='Login']")
   login_button.click
   login_button.wait_while(&:present?)
@@ -42,4 +36,4 @@ end
 
 browser.goto ENV['PAGE_URL']
 sleep 2.5 # Give a bit of time for page to load
-GenericTest.pages << GenericTest::Page.new(browser)
+GenericTest.pages << GenericTest::Page.new(browser)

data/lib/generic_test/version.rb

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

data/lib/generic_test/xpath.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Module to help form xpaths for generic identification
+module Xpath
+  class << self
+    # @return [String] Translate string to uppercase letters
+    def upcase(xpath_method)
+      "translate(#{xpath_method},'abcdefghijklmnopqrstuvwxyz','ABCDEFGHIJKLMNOPQRSTUVWXYZ')"
+    end
+
+    # @return [String] Xpath to retrieve input beside a label
+    def input_by_label(label)
+      upcase_text = upcase('text()')
+      "//input[@id=(//label[contains(#{upcase_text},'#{label.upcase}')]/@for)]"
+    end
+
+    # @return [String] Xpath to retrieve input either by a label or a attribute matching it
+    def label_or_attribute(field_name)
+      any_input_with_atr = "//input[@*='#{field_name}']"
+      input_with_text = "//input[text()='#{field_name}']"
+      [input_by_label(field_name), any_input_with_atr, input_with_text]
+        .join('|')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -16,10 +16,10 @@ require 'generic_test/setup'
 RSpec.configure do |config|
   # Close test server after all RSpec tests have run
   config.after(:suite) do
-    GenericTest.browser&.close
     if ENV['test_site_pid']
       puts "Closing test site at #{ENV['test_site_pid']}"
       Process.kill(:QUIT, ENV['test_site_pid'].to_i)
     end
+    GenericTest.browser&.close
   end
 end

data/spec/{test_gem_spec.rb → test_gem/page_spec.rb}

@@ -6,7 +6,7 @@ page = GenericTest.pages.first
 links = page.links
 
 RSpec.describe 'Links' do
-  it 'counts correctly (not include )' do
+  it 'counts correctly (not include invalid)' do
     expect(links.size).to eq 3
   end
   context 'successful' do
@@ -18,10 +18,12 @@ RSpec.describe 'Links' do
     end
   end
   it 'broken causes failure' do
+    puts page.links[1].text
+    puts page.links[1].href
     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
@@ -34,4 +36,4 @@ RSpec.describe 'Emails' do
       expect(Checker.valid_email?(page.emails[1])).to eq 'Domain name not registered'
     end
   end
-end
+end

data/spec/test_gem/xpath_spec.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'generic_test/xpath'
+
+describe Xpath do
+  context '.upcase' do
+    it 'return xpath upcase function' do
+      expect(Xpath.upcase('text()')).to include 'translate(text()'
+    end
+  end
+end

data/test_site/about.html

@@ -11,5 +11,6 @@
         All tests in this page work
     </p>
     <a href="index.html">Index page</a>
+    <a href="mailto:samuel.garratt@integrationqa.com">Email me</a>
 </body>
 </html>

data/test_site/login_page.html

@@ -0,0 +1,23 @@
+<html>
+<head>
+    <title>Login Page</title>
+</head>
+<body>
+<header>
+    <h1>Mock Login Page for testing login inputs can be entered</h1>
+</header>
+<p>
+    A login page like this can be entered before generic test done
+</p>
+<p>
+    <form action="about.html">
+        <label for="jdlksjdlsa">User-name</label>
+        <input id="jdlksjdlsa" value="username" />
+        <label for="231321321">Password</label>
+        <input id="231321321" />
+        <button type="submit">Submit</button>
+    </form>
+</p>
+<a href="index.html">Index page</a>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-20 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -235,11 +235,14 @@ files:
 - lib/generic_test/page.rb
 - lib/generic_test/setup.rb
 - lib/generic_test/version.rb
+- lib/generic_test/xpath.rb
 - spec/generic_test_spec.rb
 - spec/spec_helper.rb
-- spec/test_gem_spec.rb
+- spec/test_gem/page_spec.rb
+- spec/test_gem/xpath_spec.rb
 - test_site/about.html
 - test_site/index.html
+- test_site/login_page.html
 homepage: https://gitlab.com/samuel-garratt/generic_test
 licenses:
 - MIT