readme

README.md

@@ -1,11 +1,59 @@
 # Evidence Management Test Helper
 
-This is a client library to facilitate common task during functional tests
-
+This is a client library to facilitate common task during functional tests, like:
 - IDAM user creation
 - S2S authentication
 - CCD case creation
-- CCD DEFINITION import 
+- CCD definition import 
+
+Usage:
+
+- Include EmTestConfig in your Spring Test
+
+<pre>
+@SpringBootTest(classes = {EmTestConfig.class})
+@PropertySource(value = "classpath:application.yml")
+@RunWith(SpringRunner.class)
+public class MyTestScenario {
+</pre>
+
+- Make sure that Particular Helpers are initiated by providing URL to the respective services
+
+<pre>
+idam:
+  api:
+    url: 'http://localhost:4501'
+  client:
+    id: 'webshow'
+    secret: 'AAAAAAAAAAAAAAAA'
+    redirect_uri: 'http://localhost:8080/oauth2redirect'
+
+s2s:
+  api:
+    url: 'http://localhost:4502'
+    ccdGwSecret: 'AAAAAAAAAAAAAAAA'
+    ccdGwServiceName: 'ccd_gw'
+
+document_management:
+  url: 'http://localhost:4603'    
+
+ccd-def:
+  api:
+    url: 'http://localhost:4451'
+
+core_case_data:
+  api:
+    url: 'http://localhost:4452'
+</pre>
+
+Then @Autowire the following components:
+- IdamHelper
+- S2sHelper
+- DmHelper
+- CcdDataHelper
+- CcdDefinitionHelper
+
+see functional tests in "aat" source folder for examples
 
 ### Prerequisites