generic_test 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b24968d52699e3323d8dae288b3013aa10a699f996999b9a8d5fecbd828ec415
+  data.tar.gz: ed18d73c538f5d41ba41588d4bef8019238106a1a0f578e1e4dc2c8420bf20b8
+SHA512:
+  metadata.gz: 22fa12a82821559899257b51557b61304993c50732891577fa40cfbc8efc8a47b8bd29bfcb0b84765ab0d06208d5342427a09f2485b841466aca05f5dcb09e7b
+  data.tar.gz: 497001f35ecff93d31d44c761dc70fd30bdc95e1d4ab69a317146e2373e9db2f0947dc53d43e69ebf492d5154191d9cc7a719ad93d4997d330739d7672b8f17e

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/_site/
+/logs/
+test_site/.jekyll-cache/
+Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,46 @@
+image: ruby:2.6
+
+include:
+  - template: Code-Quality.gitlab-ci.yml
+
+docker_build:
+  variables:
+    # 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: build
+  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 build -t $CI_REGISTRY_IMAGE:latest .
+    - docker push $CI_REGISTRY_IMAGE:latest
+
+test:
+  image: registry.gitlab.com/samuel-garratt/generic_test
+  stage: test
+  script:
+    - gem install bundler
+    - bundle install
+    - xvfb-run bundle exec rake
+
+pages:
+  stage: deploy
+  script:
+    - mv test_site/ public/
+  artifacts:
+    paths:
+      - public
+    expire_in: 30 days
+  only:
+    - master
+
+.docker_test:
+  services:
+    - docker:19.03.5-dind
+  image: docker:19.03.5
+  stage: test
+  script:
+    - docker run myrepo/generic_test BASE_URL

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,32 @@
+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/*
+
+# Google chrome
+ARG CHROME_VERSION="google-chrome-stable"
+RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+  && echo "deb http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google-chrome.list \
+  && apt-get update -qqy \
+  && apt-get -qqy install \
+    ${CHROME_VERSION:-google-chrome-stable} \
+  && rm /etc/apt/sources.list.d/google-chrome.list \
+  && rm -rf /var/lib/apt/lists/* /var/cache/apt/*
+
+# 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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in generic_test.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'jekyll' # For hosting test website

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# GenericTest
+
+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
+
+`docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'generic_test'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install generic_test
+
+## Usage
+
+### Running locally. 
+
+Use the executable `generic_test`, add the page command and put a website to check:
+`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 samuel-garratt.gitlab.io/generic_test`
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://gitlab.com/samuel-garratt/generic_test. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/generic_test/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GenericTest project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/samuel-garratt/generic_test/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+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'
+end
+
+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
+  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'
+end
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'generic_test'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/generic_test

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+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
+
+Exe.start(ARGV)

data/generic_test.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'lib/generic_test/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'generic_test'
+  spec.version       = GenericTest::VERSION
+  spec.authors       = ['Samuel Garratt']
+  spec.email         = ['samuel.garratt@integrationqa.com']
+
+  spec.summary       = 'Generic tests for a website/api.'
+  spec.description   = 'Easy way to run generic tests for a website/api.'
+  spec.homepage      = 'https://gitlab.com/samuel-garratt/generic_test'
+  spec.license       = 'MIT'
+  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'
+
+  # 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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+  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 'thor'  # Command line utility
+  spec.add_dependency 'watir' # UI interaction
+  spec.add_dependency 'webdrivers' # Download chromedriver
+end

data/lib/generic_test/checker.rb

@@ -0,0 +1,7 @@
+module Checker
+  class << self
+    def link_status(href)
+      RestClient.get(href).code
+    end
+  end
+end

data/lib/generic_test/page.rb

@@ -0,0 +1,13 @@
+module GenericTest
+  class Page
+    # @return [Array] List of links
+    attr_accessor :links
+    attr_accessor :url
+
+    def initialize(url, links)
+      self.links = links
+      self.url = url
+      puts "Found #{links.count} links at #{url}"
+    end
+  end
+end

data/lib/generic_test/version.rb

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

data/lib/generic_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'generic_test/version'
+require 'generic_test/page'
+require 'generic_test/checker'
+
+module GenericTest
+  class Error < StandardError; end
+  @pages = []
+
+  class << self
+    attr_accessor :browser
+    attr_accessor :pages
+  end
+end

data/run.sh

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

data/spec/generic_test_spec.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+GenericTest.pages.each do |page|
+  links = page.links
+  RSpec.describe "Checking broken links at #{page.url}" do
+    links.each_with_index do |link, index|
+      next unless link.href && !link.href.empty?
+
+      it "Link (#{index}) #{link.text} to '#{link.href}' responds" do
+        expect(Checker.link_status(link.href)).to be_between 200, 399
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+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]
+browser_args << '--headless' if ENV['HEADLESS'] == 'true'
+
+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)
+
+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
+  end
+end

data/spec/test_gem_spec.rb

@@ -0,0 +1,15 @@
+# Test gem works internally
+
+GenericTest.pages.each do |page|
+  links = page.links
+  RSpec.describe "Checking broken links at #{page.url}" do
+    it 'successful link passes' do
+      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
+    end
+  end
+end

data/test_site/about.html

@@ -0,0 +1,13 @@
+<html>
+<head>
+    <title>About</title>
+</head>
+<body>
+    <header>
+        <h1>About page</h1>
+    </header>
+    <p>
+        Generic test page makes things easy
+    </p>
+</body>
+</html>

data/test_site/index.html

@@ -0,0 +1,16 @@
+<html>
+<head>
+    <title>Index</title>
+</head>
+<body>
+    <header>
+        <h1>Test page</h1>
+    </header>
+    <p id="correct_link">
+        <a href="about.html">About page</a>
+    </p>
+    <p id="broken_link">
+        <a href="broken_link.html">Broken link</a>
+    </p>
+</body>
+</html>

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: generic_test
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Garratt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  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:
+    - - ">="
+      - !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: thor
+  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: watir
+  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: webdrivers
+  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'
+description: Easy way to run generic tests for a website/api.
+email:
+- samuel.garratt@integrationqa.com
+executables:
+- generic_test
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- ChangeLog
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/generic_test
+- generic_test.gemspec
+- lib/generic_test.rb
+- 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
+- test_site/about.html
+- test_site/index.html
+homepage: https://gitlab.com/samuel-garratt/generic_test
+licenses:
+- MIT
+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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Generic tests for a website/api.
+test_files: []