et_fake_ccd 0.1.30 → 0.1.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 461f166cb0d439697c747600c6935205ba39e5fb8ec0eda7c82f8075c3b3a299
-  data.tar.gz: 9ae42a76d0bb6ede5c89606c05bcc638ee32a82ac91e99de609ee60bcceff437
+  metadata.gz: 292d3013013ba2ff63dfcd80c0e8bcc75905c31ce58f5123b71896519ce9511a
+  data.tar.gz: 04f5b3d3ddd7c67a813913bc5eb44de2f6c477bfb59dff40806e15581726f45a
 SHA512:
-  metadata.gz: 3a3fce9abfc823925017fcbf0f9e1233ac68c668b7bc887f40053c383a27d6f2af599a17dada887c0296200b7a6d7826b65d6224da55cfac9314e3583cb909e6
-  data.tar.gz: 0137a2a02f6526e92f1f3d2c195c3b3d99982de9d31d27cd6a5ca0e927c380ace269c4325cdda12f3b78ad2fea11c6f771310c594c230d314728c0df3d64d9fe
+  metadata.gz: c149b5501179a89fdfddbe5ffbff890689153cba32d521b763554356d7c47adb768e025ba06559f66bd06f36abbc04cca81117e0b705155b9da837de46c03531
+  data.tar.gz: 8881ea586996e17eb191f23aa432d3b55ada8cef241e32fb5d0e0bdf4f25aa755eaca8385ae94d7793681e029d5d6f30a3e1ba6684849d44029f90ae0790ebbc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    et_fake_ccd (0.1.30)
+    et_fake_ccd (0.1.31)
       activemodel (>= 5.2.3)
       iodine (~> 0.7)
       roda (~> 3.21)
@@ -27,7 +27,7 @@ GEM
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     iodine (0.7.33)
-    minitest (5.11.3)
+    minitest (5.12.2)
     public_suffix (4.0.1)
     rack (2.0.7)
     rake (10.5.0)
@@ -50,7 +50,7 @@ GEM
     rspec-support (3.8.2)
     thor (0.20.3)
     thread_safe (0.3.6)
-    tilt (2.0.9)
+    tilt (2.0.10)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     zeitwerk (2.1.10)

data/README.md

@@ -25,7 +25,70 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+To run the server, use the command
+
+```
+et_fake_ccd start
+```
+
+## Testing Using This Fake Server
+
+In general, this server will try to act like the normal CCD server but only in terms of accepting
+and storing data.
+So, it stores the data that the application gives it and it allows that data to be read back so
+that a test suite or a manual process can validate that data.
+
+It also has some basic validation so that it behaves in a similar way to CCD, but due to the complexity of
+CCD itself, this app can never reflect exactly how it validates.
+
+So, for this reason, deliberate errors are added to this server.
+
+### Testing Using Deliberate Errors
+
+When you think about it, if there was a way in the application to force an error, the developer 
+would fix it !  So, we have to rely on having some deliberate errors where the data will pass through
+all the validation within the app, but this server then knows to respond as if it was an error.
+
+This will allow a tester or a test suite to provide the magic values that will trigger certain 
+error scenarios and prove that the app behaves as expected under these error conditions.
+
+This allows for basic testing and is not intended to be real life - only real life will give you 
+real life errors.
+
+For example, lets say we chose the name "Fred Bloggs" (sorry, the real fred bloggs - you must get fed
+up with people using your name) to always respond with a 403 error saying "Forbidden".
+
+Obviously, you could not force the app to get a real forbidden error, so as a tester or a developer 
+writing test code, you would know from this readme that Fred Bloggs always causes a 403 error,
+therefore you would expect the exported case in the admin to be marked with an error as an example.
+
+So, here is a list of deliberate errors that Im sure will increase in size :-
+
+#### Force a 403 error every time
+
+* Use the lead claimant name "Force Error403"
+
+#### Force a 403 error for just the first time
+
+* Use the lead claimant name "Force Error403-<n>" (replace <n> with a number unique to your test)
+
+#### Force a 504 error
+* Use the lead claimant name "Force Error504"
+* Use the lead claimant title of "Mr" to only force the error on the first occurence
+* Use the lead claimant title of "Mrs" to force the error on every occurence
+
+#### Force a 502 error
+* Use the lead claimant name "Force Error502"
+* Use the lead claimant title of "Mr" to only force the error on the first occurence
+* Use the lead claimant title of "Mrs" to force the error on every occurence
+
+#### Force a 422 error
+* Use the lead claimant name "Force Error422"
+* Use the lead claimant title of "Mr" to only force the error on the first occurence
+* Use the lead claimant title of "Mrs" to force the error on every occurence
+
+
+
 
 ## Development
 

data/lib/et_fake_ccd/request_store_service.rb

@@ -0,0 +1,58 @@
+require "singleton"
+module EtFakeCcd
+  class RequestStoreService
+    include Singleton
+    def self.store(request_id)
+      instance.store(request_id)
+    end
+
+    def self.count(request_id)
+      instance.count(request_id)
+    end
+
+    def store(request_id)
+      adapter.store(request_id)
+    end
+
+    def count(request_id)
+      adapter.count(request_id)
+    end
+
+    def adapter
+      @adapter ||= InMemoryAdapter.new
+    end
+
+    class InMemoryAdapter
+      TTL = 1800
+      def initialize
+        self.data = {}
+      end
+
+      def store(request_id)
+        expire_old_requests(request_id)
+        data[request_id] ||= []
+        data[request_id] << Time.now.utc
+      end
+
+      def count(request_id)
+        expire_old_requests(request_id)
+        return 0 if data[request_id].nil?
+
+        data[request_id].length
+      end
+
+      private
+
+      attr_accessor :data
+
+      def expire_old_requests(request_id)
+        return unless data.key?(request_id) && data[request_id].length > 0
+
+        last_request = data[request_id].max
+        if (Time.now - last_request) > TTL
+          data[request_id].clear
+        end
+      end
+    end
+  end
+end

data/lib/et_fake_ccd/service/data_store_app.rb

@@ -3,6 +3,7 @@ require 'json'
 require 'et_fake_ccd/commands'
 require 'et_fake_ccd/auth_service'
 require 'et_fake_ccd/data_store_service'
+require 'et_fake_ccd/request_store_service'
 module EtFakeCcd
   module Service
     class DataStoreApp < Roda
@@ -64,12 +65,14 @@ module EtFakeCcd
               break
             end
             json = JSON.parse(r.body.read)
+            next if force_deliberate_error(json, r)
+
             command = case json.dig('event', 'id')
-                      when 'initiateCase' then ::EtFakeCcd::Command::CreateCaseCommand.from_json json
+            when 'initiateCase' then ::EtFakeCcd::Command::CreateCaseCommand.from_json json
                       when 'createBulkAction' then ::EtFakeCcd::Command::CreateBulkActionCaseCommand.from_json json
                       else
                         r.halt 400, unknown_event_error_for(r)
-            end
+                      end
             if command.valid?
               id = ::EtFakeCcd::DataStoreService.store_case_data(command.data, jid: jid, ctid: ctid)
               case_created_response(id, uid, jid, ctid)
@@ -94,6 +97,66 @@ module EtFakeCcd
 
       private
 
+      def force_deliberate_error(data, r)
+        return false unless data.dig('data', 'claimantIndType', 'claimant_first_names').strip.downcase == 'force'
+        error, client_id = data.dig('data', 'claimantIndType', 'claimant_last_name').split('-')
+        if client_id.nil?
+          render_error(error)
+        else
+          track_request_id("#{error}-#{client_id}")
+          return false unless should_error_for_request_id?("#{error}-#{client_id}")
+          render_error(error)
+        end
+        true
+      end
+
+      def render_error(error)
+        method_name = "render_#{error.downcase}".to_sym
+        return unless respond_to?(method_name, true)
+
+        send method_name
+      end
+
+      def track_request_id(request_id)
+        RequestStoreService.store request_id
+      end
+
+      def should_error_for_request_id?(request_id)
+        RequestStoreService.count(request_id) > 0
+      end
+
+      def render_error403
+        r.halt 403, forbidden_error_for(r)
+      end
+
+      def render_error504
+        j = {"timestamp":"2019-07-01T07:46:35.405+0000","status":504,"error":"Forbidden","message":"Access Denied","path": r.path}
+        r.halt 504, JSON.generate(j)
+      end
+
+      def render_error502
+        j = {"timestamp":"2019-07-01T07:46:35.405+0000","status":502,"error":"Forbidden","message":"Access Denied","path": r.path}
+        r.halt 502, JSON.generate(j)
+      end
+
+      def render_error422
+        j = {
+          "exception": "uk.gov.hmcts.ccd.endpoint.exceptions.CaseValidationException",
+          "timestamp": "2019-07-01T16:02:28.045",
+          "status": 422,
+          "error": "Unprocessable Entity",
+          "message": "Case data validation failed",
+          "path": request.path,
+          "details": {
+            "field_errors": command.errors.details[:data].map {|e| e[:field_error]}
+          },
+          "callbackErrors": nil,
+          "callbackWarnings": nil
+        }
+
+        r.halt 422, JSON.generate(j)
+      end
+
       def initiate_case(uid, jid, ctid)
         j = {
             "token": "eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiJvZDRwZ3NhbDQwcTdndHI0Y2F1bmVmZGU5aSIsInN1YiI6IjIyIiwiaWF0IjoxNTYxOTY2NzM1LCJldmVudC1pZCI6ImluaXRpYXRlQ2FzZSIsImNhc2UtdHlwZS1pZCI6IkVtcFRyaWJfTVZQXzEuMF9NYW5jIiwianVyaXNkaWN0aW9uLWlkIjoiRU1QTE9ZTUVOVCIsImNhc2UtdmVyc2lvbiI6ImJmMjFhOWU4ZmJjNWEzODQ2ZmIwNWI0ZmEwODU5ZTA5MTdiMjIwMmYifQ.u-OfexKFu52uvSgTNVHJ5kUQ9KTZGClRIRnGXRPSmGY",

data/lib/et_fake_ccd/version.rb

@@ -1,3 +1,3 @@
 module EtFakeCcd
-  VERSION = "0.1.30"
+  VERSION = "0.1.31"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: et_fake_ccd
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.1.31
 platform: ruby
 authors:
 - Gary Taylor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -177,6 +177,7 @@ files:
 - lib/et_fake_ccd/data_store_service.rb
 - lib/et_fake_ccd/document_store_service.rb
 - lib/et_fake_ccd/iodine.rb
+- lib/et_fake_ccd/request_store_service.rb
 - lib/et_fake_ccd/root_app.rb
 - lib/et_fake_ccd/service/api_gateway_web_app.rb
 - lib/et_fake_ccd/service/auth_app.rb