generic_test 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5511c72398002fc4468de6f4e1e6a3f8c27783fd2cbeef28decae9a833698f57
-  data.tar.gz: 4aaad3513df4be30725c97ac25fd07bc052bc90dac9b7270d286c1f5ce017090
+  metadata.gz: a5dc87e6158431181b42b3d8775d112382c54617cb5f519657064bb21650a5ac
+  data.tar.gz: 9662978df60eb50b37033056dca365c192e7891a5546159a3d4e34e6a62b6911
 SHA512:
-  metadata.gz: 4848379d61b1064629f36ca3861759a564ee2fe4d156afb235c6a1eddce86dfd14b05980b6d45dec81b46404d5ce27b81a78fe2f25372ac2040bc5ac480283fe
-  data.tar.gz: 5c92f007d44d6bcfc74113c091c2fab49a1266c1eef09b093220660eeb2d3db34424f3663f0b752e3c01660df1b8699459954aac88e21e013cf84916f8717370
+  metadata.gz: b079ecf7d4f14cd88d64766ed3e49f34052ee349951fdce2c9ec5785e601e8d43c826daaa87f7f693e94c7480b8bfa3d04f5649ce9fbad44793b88a13ce39f52
+  data.tar.gz: 22192bdb59c6563dc8228292328f6a3838476143fbc8753569f3cab00c647d2bc7d326133a82330ce8a31084009f78d4ba0033d4dca921c7d73f51f408f79364

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/ChangeLog

@@ -1,3 +1,8 @@
+Version 0.1.13
+* Enhancement
+  * Fail if cannot find url of page provided
+  * Ignore checking duplicate links
+
 Version 0.1.12
 * Enhancement
   * More generic matching of username labels allowing any case to be used

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/generic_test.gemspec

@@ -29,7 +29,8 @@ Gem::Specification.new do |spec|
   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
+  # This doesn't work with latest Ruby version
+  #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
 

data/lib/generic_test/setup.rb

@@ -34,6 +34,8 @@ if ENV[GT_LOGIN_URL] && ENV[GT_USERNAME] && ENV[GT_PASSWORD]
   puts "Login through #{ENV[GT_LOGIN_URL]} successful!"
 end
 
+ENV['PAGE_URL'] = RestClient.get(ENV['PAGE_URL']).request.url # Check page exists
+puts "Checking #{ENV['PAGE_URL']}"
 browser.goto ENV['PAGE_URL']
 sleep 2.5 # Give a bit of time for page to load
 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.12'
+  VERSION = '0.2.0'
 end

data/lib/generic_test.rb

@@ -15,9 +15,11 @@ module GenericTest
   # browser so less likely to be accurate for logged in pages
   @only_javascript = false
 
+  @tested_links = []
   class << self
     attr_accessor :browser
     attr_accessor :pages
+    attr_accessor :tested_links
     attr_accessor :only_javascript
   end
 end

data/spec/generic_test_spec.rb

@@ -7,10 +7,14 @@ links = page.links
 RSpec.describe "#{page.title} Links respond" do
   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
     it "Link (#{index + 1})#{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
 
 emails = page.emails

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: generic_test
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Garratt
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-26 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !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
@@ -250,7 +236,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 +251,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: []