generic_test 0.1.13 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7fd4592cd7c34e39ae05d9db02ea20dd6ca739f368851db22dac04168504ec1
-  data.tar.gz: fb55093d314dfc89e13d0ec4342317106d6caef89dcd9e7341c42c79a59f464b
+  metadata.gz: 9b1c9696f0ea835b89da12a7d1b95289955fc66097fa614009775acde222a5bd
+  data.tar.gz: 0ed1be3abda02a988dbd7befb16f4a6e725566e1a911e0c842268e371acc85f3
 SHA512:
-  metadata.gz: f5ec80dd8977f15b6ffc3a66cec286a2183da371a10eb4d4428ff0f607d849e818bc303ffa96c3295e9ba787f7dcf092e95d64729318dcd357ee390937ec9680
-  data.tar.gz: 92d050bbbd02da8821ba2685cec5bcf86a1187a3f9a3ab82d4cc0ef44b0bc5d47644c520e81b5fd8859293021b840bb16571cf407f7fdc08924beaf67dbef97f
+  metadata.gz: f69e2f461c62fcd4be622afbc3754197c6731d8d650aeffd5727f80514237aa136d347a131f94c6ab889f1ae3a62d5e9aad010eeff917932eefc04bf2be7715e
+  data.tar.gz: ae3bd8b8c02e3d269b55916482098a6dd3b86ef8e05ebb7a1aecb117f09d0e19a0b49d8233f8b393832d357f153fcc4ca3f846a589c3865eb5b9fe24927e1950

data/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: ruby:2.6
+image: ruby:3.3
 
 include:
   - template: Code-Quality.gitlab-ci.yml
@@ -8,16 +8,22 @@ 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: deploy # Part of a later stage
+  stage: test # Part of a later stage
   services:
-    - docker:19.03.5-dind
-  image: docker:19.03.5
+    - docker:20.10.11-dind
+  image: docker:20.10.11
   script:
     - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
     - docker pull --quiet $CI_REGISTRY_IMAGE:latest || true
     - 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"
 
 test:
   image: registry.gitlab.com/samuel-garratt/generic_test
@@ -34,6 +40,23 @@ test:
     expire_in: 1 week
     when: always
 
+# Example of using generic test
+example_test:
+  stage: test
+  image: registry.gitlab.com/samuel-garratt/generic_test
+  script:
+    - generic_test page samuel-garratt.gitlab.io/generic_test/about.html
+  variables:
+    GIT_STRATEGY: none
+  artifacts:
+    paths:
+      - logs/*.xml
+      - reports
+    reports:
+      junit: logs/*.xml
+    expire_in: 1 week
+    when: always
+
 pages:
   stage: deploy
   script:
@@ -51,4 +74,4 @@ pages:
   image: docker:19.03.5
   stage: test
   script:
-    - docker run myrepo/generic_test BASE_URL
+    - docker run myrepo/generic_test BASE_URL

data/.rspec

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

data/Dockerfile

@@ -1,5 +1,5 @@
-FROM ruby:2.6
-MAINTAINER Samuel Garratt
+FROM ruby:3.3
+LABEL AUTHOR=SamuelGarratt
 
 # Required ruby gems
 RUN mkdir /test
@@ -21,4 +21,6 @@ RUN export LANG=C.UTF-8
 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
+RUN generic_test page samuel-garratt.gitlab.io/generic_test/about.html
+
+ENTRYPOINT ["generic_test", "page"]

data/README.md

@@ -2,7 +2,9 @@
 
 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
+Test site is at [https://samuel-garratt.gitlab.io/generic_test](https://samuel-garratt.gitlab.io/generic_test)
+
+## Quick start
 
 Run test gem through docker against this website with (Note it is an example that has some failures)
 
@@ -14,6 +16,27 @@ 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
 
+## Add to gitlab CI for your website
+
+Add the following `YAML` to test against a website
+```yaml
+example_test:
+  stage: test
+  image: registry.gitlab.com/samuel-garratt/generic_test
+  script:
+    - generic_test page YOUR_WEBSITE_URL
+  variables:
+    GIT_STRATEGY: none # Make more efficient and remove any dependency conflicts
+  artifacts:
+    paths:
+      - logs/*.xml
+      - reports # HTML reports
+    reports:
+      junit: logs/*.xml
+    expire_in: 1 week
+    when: always
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,6 +71,10 @@ E.g.,
 
 `docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test page samuel-garratt.gitlab.io/generic_test`
 
+Check version
+
+`docker run -t registry.gitlab.com/samuel-garratt/generic_test generic_test version`
+
 ### Through login page
 
 Environment variables store Login URL, username and password
@@ -78,11 +105,17 @@ login:
 
 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).
+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).
+
+The pipeline running on master will deploy a new version of the docker container with the latest version released
+to rubygems.org. Therefore a `rake release` is required before any changes will be reflected in the newly built
+docker container.
 
 ## 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).
+Bug reports and pull requests are welcome on GitLab 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://gitlab.com/samuel-garratt/generic_test/-/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/exe/generic_test

@@ -16,7 +16,7 @@ class Exe < Thor
     desc = ENV['PAGE_URL'].split('://').last.tr('/', '_')
     junit_format = "-f RspecJunitFormatter --out logs/page_#{desc}.xml"
     ENV['REPORT_PATH'] = "reports/#{desc}"
-    html_format = '--require generic_test/html_reporter -f RspecHtmlReporter'
+    html_format = '--format html --out report.html'
     command = "rspec #{test_file_path} --format documentation --color #{junit_format} #{html_format}"
     raise $CHILD_STATUS.to_s unless system command
   end

data/generic_test.gemspec

@@ -28,8 +28,6 @@ Gem::Specification.new do |spec|
   # Development dependencies are installed too since running external tests within gem
   spec.add_development_dependency 'jekyll' # For hosting test website
   spec.add_development_dependency 'rake'
-  spec.add_dependency 'rspec-legacy_formatters' # Needed for rspec_html_reporter after RSpec 3
-  spec.add_dependency 'rspec_html_reporter'   # Pretty HTML reports
   spec.add_dependency 'rspec_junit_formatter' # Needed for nicer reporting of rspec for use in CI
   spec.add_dependency 'simplecov'     # Code coverage
 
@@ -39,6 +37,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'spellcheck'    # Check for common spelling errors
   spec.add_dependency 'thor'          # Command line utility
   spec.add_dependency 'watir'         # UI interaction
-  spec.add_dependency 'webdrivers'    # Download chromedriver automatically
   spec.add_dependency 'yamler'
 end

data/lib/generic_test/html_reporter.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Mock implementation of Bundler for use by generic_test where Bundler.root is needed
-module Bundler
-  class << self
-    # Used just so that RSpecHtmlReporter does not thrown an error
-    def root
-      ''
-    end
-  end
-end
-
-require 'rspec_html_reporter'

data/lib/generic_test/setup.rb

@@ -9,7 +9,7 @@ ENV['PAGE_NUM'] ||= '1'
 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
+GenericTest.browser = Watir::Browser.new :chrome, options: { args: browser_args }
 
 raise 'PAGE_URL environment variable not set' unless ENV['PAGE_URL']
 

data/lib/generic_test/version.rb

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

data/lib/generic_test.rb

@@ -5,7 +5,6 @@ require 'generic_test/page'
 require 'generic_test/checker'
 require 'spellcheck'
 require 'watir'
-require 'webdrivers'
 
 # Handles testing of sites generically for common issues
 module GenericTest

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.1.13
+  version: 0.2.1
 platform: ruby
 authors:
 - Samuel Garratt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-legacy_formatters
-  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_html_reporter
-  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_junit_formatter
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +150,6 @@ dependencies:
     - - ">="
       - !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'
 - !ruby/object:Gem::Dependency
   name: yamler
   requirement: !ruby/object:Gem::Requirement
@@ -250,7 +208,7 @@ 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/generic_test/blob/master/ChangeLog
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -265,8 +223,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Generic tests for a website/api.
 test_files: []