dvla-application_helper 5.1.5

data/Rakefile

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+task specs: %i[spec]
+
+namespace :seed_app do
+  task :dev do |_t|
+    ENV['ENVIRONMENT'] = 'local-dev'
+    require './scripts/seed_application.rb'
+  end
+
+  task :link do |_t|
+    ENV['ENVIRONMENT'] = 'local-link'
+    require './scripts/seed_application.rb'
+  end
+
+  task :drone do |_t|
+    ENV['ENVIRONMENT'] = 'drone-dev' unless ENV.has_key?('ENVIRONMENT')
+    require './scripts/seed_application.rb'
+  end
+end

data/config/settings/drone-dev.yml

@@ -0,0 +1,41 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 02c656e6ddb2ce558
+    driving_licence_channel_api:
+      stage_name: dev
+      api_id: v5xx72m7z5
+    application_diary:
+      stage_name: dev
+      api_id: 0r7n1n0t2i
+    application_domain:
+      stage_name: dev
+      api_id: pc4j6sohv8
+    application_process_engine:
+      stage_name: dev
+      api_id: tokuf48me0
+    state_machine:
+      stage: dev
+      account_id: 129805137803
+    image_service:
+      base_url: https://flvh6n0yx6-vpce-02c656e6ddb2ce558.execute-api.eu-west-2.amazonaws.com/link/
+    image_utility:
+      base_url: https://r8t8c9sl7g-vpce-02c656e6ddb2ce558.execute-api.eu-west-2.amazonaws.com/link/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+customer_helper:
+  services:
+    customer_domain:
+      url: https://customer-account-domain-link.int-api.dvla.gov.uk
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: 'application/json'
+

data/config/settings/drone-ext.yml

@@ -0,0 +1,35 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 02c656e6ddb2ce558
+    driving_licence_channel_api:
+      stage_name: ext
+      api_id: a88xitdml4
+    application_diary:
+      stage_name: ext
+      api_id: 1h0v1ex2i5
+    application_domain:
+      stage_name: ext
+      api_id: 1hqw5nske8
+    application_process_engine:
+      stage_name: ext
+      api_id: 4xikwxe17a
+    state_machine:
+      stage: ext
+      account_id: 736948357641
+    image_service:
+      base_url: https://oh1b5v3xde-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+    image_utility:
+      base_url: https://nzzfur5hr8-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: 'application/json'

data/config/settings/drone-link.yml

@@ -0,0 +1,35 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 02c656e6ddb2ce558
+    driving_licence_channel_api:
+      stage_name: link
+      api_id: f4mwdzovfb
+    application_diary:
+      stage_name: link
+      api_id: 8udjdqaoy4
+    application_domain:
+      stage_name: link
+      api_id: ehjf4jjgz4
+    application_process_engine:
+      stage_name: link
+      api_id: kq9xf7gl1j
+    state_machine:
+      stage: link
+      account_id: 736948357641
+    image_service:
+      base_url: https://flvh6n0yx6-vpce-02c656e6ddb2ce558.execute-api.eu-west-2.amazonaws.com/link/
+    image_utility:
+      base_url: https://r8t8c9sl7g-vpce-02c656e6ddb2ce558.execute-api.eu-west-2.amazonaws.com/link/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: 'application/json'

data/config/settings/drone-perf.yml

@@ -0,0 +1,35 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 02c656e6ddb2ce558
+    driving_licence_channel_api:
+      stage_name: perf
+      api_id: j64krkvhc3
+    application_diary:
+      stage_name: perf
+      api_id: m14vif8hpb
+    application_domain:
+      stage_name: perf
+      api_id: wemjsgw805
+    application_process_engine:
+      stage_name: perf
+      api_id: 4xikwxe17a
+    state_machine:
+      stage: perf
+      account_id: 736948357641
+    image_service:
+      base_url: https://oh1b5v3xde-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+    image_utility:
+      base_url: https://nzzfur5hr8-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: 'application/json'

data/config/settings/local-dev.yml

@@ -0,0 +1,40 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 0c9077c8fe760fea6
+    driving_licence_channel_api:
+      stage_name: dev
+      api_id: v5xx72m7z5
+    application_diary:
+      stage_name: dev
+      api_id: 0r7n1n0t2i
+    application_domain:
+      stage_name: dev
+      api_id: pc4j6sohv8
+    application_process_engine:
+      stage_name: dev
+      api_id: tokuf48me0
+    state_machine:
+      stage: dev
+      account_id: 129805137803
+    image_service:
+      base_url: https://flvh6n0yx6-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/link/
+    image_utility:
+      base_url: https://r8t8c9sl7g-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/link/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+customer_helper:
+  services:
+    customer_domain:
+      url: https://customer-account-domain-link.int-api.dvla.gov.uk
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: "application/json"

data/config/settings/local-ext.yml

@@ -0,0 +1,35 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 0c9077c8fe760fea6
+    driving_licence_channel_api:
+      stage_name: ext
+      api_id: a88xitdml4
+    application_diary:
+      stage_name: ext
+      api_id: 1h0v1ex2i5
+    application_domain:
+      stage_name: ext
+      api_id: nhlx046br4
+    application_process_engine:
+      stage_name: ext
+      api_id: 4xikwxe17a
+    state_machine:
+      stage: ext
+      account_id: 736948357641
+    image_service:
+      base_url: https://oh1b5v3xde-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+    image_utility:
+      base_url: https://nzzfur5hr8-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: 'application/json'

data/config/settings/local-link.yml

@@ -0,0 +1,35 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 0c9077c8fe760fea6
+    driving_licence_channel_api:
+      stage_name: link
+      api_id: f4mwdzovfb
+    application_diary:
+      stage_name: link
+      api_id: 8udjdqaoy4
+    application_domain:
+      stage_name: link
+      api_id: ehjf4jjgz4
+    application_process_engine:
+      stage_name: link
+      api_id: ugfo40du36
+    state_machine:
+      stage: link
+      account_id: 736948357641
+    image_service:
+      base_url: https://flvh6n0yx6-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/link/
+    image_utility:
+      base_url: https://r8t8c9sl7g-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/link/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: "application/json"

data/config/settings/local-perf.yml

@@ -0,0 +1,35 @@
+application_helper:
+  services:
+    aws:
+      vpce_id: 0c9077c8fe760fea6
+    driving_licence_channel_api:
+      stage_name: perf
+      api_id: j64krkvhc3
+    application_diary:
+      stage_name: perf
+      api_id: m14vif8hpb
+    application_domain:
+      stage_name: perf
+      api_id: wemjsgw805
+    application_process_engine:
+      stage_name: perf
+      api_id: 4xikwxe17a
+    state_machine:
+      stage: perf
+      account_id: 736948357641
+    image_service:
+      base_url: https://oh1b5v3xde-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+    image_utility:
+      base_url: https://nzzfur5hr8-vpce-0c9077c8fe760fea6.execute-api.eu-west-2.amazonaws.com/preprod/
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', '') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+poirot:
+  services:
+    addressing:
+      base: https://common-services-addressing-link.int-api.dvla.gov.uk
+    identity_stub:
+      base: https://identity-identity-stub-link.int-api.dvla.gov.uk
+      headers:
+        Content-Type: 'application/json'

data/config/settings.yml

@@ -0,0 +1,29 @@
+logs:
+  log_level: DEBUG
+
+customer_id: '01102e86-26fe-4068-b654-7e3524d1a090'
+
+application_helper:
+  applicant_email:
+    email_prefix: <%= ENV.fetch('EMAIL_PREFIX', 'dvla-tyr') %>
+    email_domain: <%= ENV.fetch('EMAIL_DOMAIN', 'dvla.msdc.co') %>
+
+yarp:
+  enabled: <%= ENV.fetch('YARP_ENABLED', false) %>
+
+test:
+  product_type: [Vehicles,Driving Licence,Test]
+  #  driverId's below are static ids used within the DL channel api stub, allows aps to pass through eligibility and validation with the required response
+  driver_id:
+    always_duplicate: 8053dc90-a91c-4ee4-88c3-d89c114661bc
+    always_replacement: 16112ae7-77f5-4a1c-a615-c3e82244a692
+    always_exchange: 21b6e437-8f0c-42ae-8b61-62d53f377841
+    optional_cop: cef7f25e-a799-40cb-88c4-ec2a5e5e5fad
+    mandatory_tyr: fb2e0dff-b948-4337-84b4-adfd668f68fd
+    paper_duplicate: 06ab86ce-7775-4848-84f0-df19406ee951
+    paper_replacement: fdd8d5b1-ea21-440f-814a-6ae0e272e9c5
+
+application:
+  v1_schema: https://osl-data-dictionary-schemas.engineering.dvla.gov.uk/driving-licence-application/applications/v1/update-ordinary-driving-licence-application.json#properties/data
+  v2_schema: https://osl-data-dictionary-schemas.engineering.dvla.gov.uk/driving-licence-application/applications/v2/update-ordinary-driving-licence-application.json
+  v3_schema: https://osl-data-dictionary-schemas.engineering.dvla.gov.uk/driving-licence-application/applications/v3/update-ordinary-driving-licence-application.json

data/config/yarp.yml

@@ -0,0 +1,6 @@
+#api_key: <%= ENV['YARP_api_key'] || nil %> # Set YARP_BUILD_NUMBER | Likely to be set in your CI/CD pipeline
+#build_number: # Set YARP_BUILD_NUMBER | Likely to be set in your CI/CD pipeline
+endpoint: https://yarp.prod.tooling.dvla.gov.uk/
+error_limit: 5
+launch:
+project: ap/drivers-application-helper-gem

data/functional-tests/Rakefile

@@ -0,0 +1,74 @@
+require 'bundler/setup'
+Bundler.require
+
+require 'chutney'
+require 'chutney/formatter'
+require 'chutney/formatter/rainbow_formatter'
+require 'config'
+require 'pastel'
+require 'parallel_tests'
+require 'open3'
+
+pastel = Pastel.new
+parallel = ParallelTests::CLI.new
+test_formatter = ENV['YARP_ENABLED'] == 'true' ? 'DVLA::Yarp::Cucumber' : 'pretty'
+
+task default: ['test:functional']
+
+desc 'Scan for unused step definitions'
+task :unused_step_defs do
+  puts pastel.yellow('Starting scan for unused step definitions...')
+  command_string = "bundle exec cucumber --dry-run --format stepdefs | grep -B1 'NOT MATCHED BY ANY STEPS' | grep -v 'NOT MATCHED BY ANY STEPS' | grep -v 'be axe clean'"
+  stdout, _stderr, _status = Open3.capture3(command_string)
+  # fail build if offence found
+  abort("\nI've found some unused step definitions. Please fix the following: \n#{pastel.red(stdout)}\n") unless stdout.empty?
+  # if no offence found
+  puts pastel.green("\n...No unused step definitions found. Great work!\n")
+end
+
+desc 'Scan for undefined step definitions'
+task :undefined_step_defs do
+  puts pastel.yellow('Starting scan for undefined step definitions...')
+  command_string = "bundle exec cucumber --dry-run --format stepdefs | grep -A 100 'You can implement step definitions for undefined steps with these snippets:'| grep -v 'be axe clean'"
+  stdout, _stderr, _status = Open3.capture3(command_string)
+
+  if stdout.empty?
+    puts pastel.green("\n...No undefined step definitions found. Great work!\n")
+  else
+    abort("\nI've found some undefined step definitions. Please fix the following: \n#{pastel.red(stdout)}\n")
+  end
+end
+
+desc 'Scan for failure ignores in the drone.yml'
+task :fail_safe do
+  container = ''
+  file = File.readlines('../.drone.yml')
+  file.each do |line|
+    line.match?(/- name:*/) ? (container = line) : nil
+
+    if line.match?(/failure: ignore/) && container.match?(/test/)
+      abort(pastel.red("Failure ignore found in tests: #{pastel.red(container)}"))
+    elsif line.match?(/failure: ignore/)
+      puts "Failure ignore found in:#{pastel.yellow(container)}"
+    end
+  end
+end
+
+desc 'Run linting on functional-tests'
+task :lint do
+  sh 'bundle exec chutney'
+  sh 'bundle exec rubocop'
+  sh 'bundle exec rake unused_step_defs'
+  sh 'bundle exec rake undefined_step_defs'
+  sh 'bundle exec rake fail_safe'
+end
+
+namespace :test do
+  desc 'Run the functional test suite'
+  task :functional, %i[cucumber_path threads] do |_t, args|
+    puts "running function tests with path #{args[:cucumber_path]}"
+    puts "test_formatter is: #{test_formatter}"
+    puts "number of threads is: #{args[:threads]}"
+    parallel.run(%W[-n #{args[:threads]} --type cucumber --group-by scenarios --serialize-stdout -- -f #{test_formatter} --out /dev/null -f progress -t #{'not @wip'} --retry 1 -- #{args[:cucumber_path]}])
+  end
+end

data/functional-tests/chutney.yml

@@ -0,0 +1,110 @@
+AvoidOutlineForSingleExample:
+  Enabled: false
+# Revert this back to true once V3 updates have all gone in and tests uncommented
+
+AvoidPeriod:
+  Enabled: true
+
+AvoidScripting:
+  Enabled: true
+
+avoid_splat_steps_in_background:
+  Enabled: true
+
+avoid_splat_steps_in_scenarios:
+  Enabled: true
+
+AvoidTypographersQuotes:
+  Enabled: true
+
+BackgroundDoesMoreThanSetup:
+  Enabled: true
+
+BackgroundRequiresMultipleScenarios:
+  Enabled: true
+
+BadScenarioName:
+  Enabled: true
+
+BeDeclarative:
+  Enabled: true
+
+FileNameDiffersFeatureName:
+  Enabled: true
+
+GivensAfterBackground:
+  Enabled: true
+
+MissingExampleName:
+  Enabled: true
+
+MissingFeatureDescription:
+  Enabled: true
+
+MissingFeatureName:
+  Enabled: true
+
+MissingScenarioName:
+  Enabled: true
+
+MissingScenarioOutline:
+  Enabled: true
+
+MissingTestAction:
+  Enabled: true
+
+MissingVerification:
+  Enabled: true
+
+InvalidFileName:
+  Enabled: true
+
+InvalidStepFlow:
+  Enabled: true
+
+RequiredTagsStartsWith:
+  Enabled: true
+
+SameTagDifferentCase:
+  Enabled: true
+
+SameTagForAllScenarios:
+  Enabled: true
+
+ScenarioNamesMatch:
+  Enabled: true
+  Matcher: ^AC.*
+
+TagUsedMultipleTimes:
+  Enabled: true
+
+TooClumsy:
+  Enabled: false
+
+TooManyDifferentTags:
+  Enabled: false
+
+TooManySteps:
+  Enabled: true
+
+TooManyTags:
+  Enabled: true
+
+TooLongStep:
+  Enabled: true
+  MaxLength: 140
+
+UniqueScenarioNames:
+  Enabled: true
+
+UnknownVariable:
+  Enabled: true
+
+UnusedVariable:
+  Enabled: true
+
+UseBackground:
+  Enabled: true
+
+UseOutline:
+  Enabled: false