adding some hints and solutions and an HTTP test class for the simulator examples

Author: eviltester

challenger/src/main/java/uk/co/compendiumdev/challenge/challenges/ChallengeDefinitions.java

@@ -82,7 +82,7 @@ public ChallengeDefinitions(ChallengerConfig config){
 
         // CREATE with POST
         ChallengeSection postCreateChallenges = new ChallengeSection("Creation Challenges with POST",
-                "A POST request can be used to create and update data, these challenges are to 'create' data. As a Hint, if you are not sure what the message body should be, try copying in the response from the associated GET request, and amending it.");
+                "A POST request can be used to create and update data, these challenges are to 'create' data.");
         sections.add(postCreateChallenges);
 
         storeChallengeAs(CHALLENGE.POST_TODOS, PostChallenges.postTodos201(challengeOrder++), postCreateChallenges);
@@ -97,7 +97,7 @@ public ChallengeDefinitions(ChallengerConfig config){
 
         // CREATE with PUT
         ChallengeSection putCreateChallenges = new ChallengeSection("Creation Challenges with PUT",
-                "A PUT request can often used to create and update data. The todo application we are using has automatically generated ids, so you cannot use PUT to create. As a Hint, if you are not sure what the message body should be, try copying in the response from the associated GET request, and amending it.");
+                "A PUT request can often used to create and update data. The todo application we are using has automatically generated ids, so you cannot use PUT to create.");
         sections.add(putCreateChallenges);
 
         storeChallengeAs(CHALLENGE.PUT_TODOS_400, PutChallenges.putTodosId400(challengeOrder++), putCreateChallenges);

challenger/src/main/java/uk/co/compendiumdev/challenge/challenges/definitions/ChallengerChallenges.java

@@ -10,7 +10,7 @@ public static ChallengeDefinitionData createChallenger201(int challengeOrder) {
                 "POST /challenger (201)",
                 "Issue a POST request on the `/challenger` end point, with no body, to create a new challenger session. Use the generated X-CHALLENGER header in future requests to track challenge completion."
         );
-        aChallenge.addHint("In multi-user mode, you need to create an X-CHALLENGER Session first", "/gui/multiuser");
+        aChallenge.addHint("In multi-user mode, you need to create an X-CHALLENGER Session in order to complete any challenges or make PUT, POST, DELETE requests", "/gui/multiuser");
         aChallenge.addSolutionLink("Send request using POST to /challenger endpoint. The response has an X-CHALLENGER header, add this header X-CHALLENGER and the GUID value to all future requests.","","");
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/create-session/post-challenger-201");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "tNGuZMQgHxw");

challenger/src/main/java/uk/co/compendiumdev/challenge/challenges/definitions/GetChallenges.java

@@ -10,6 +10,10 @@ public static ChallengeDefinitionData getChallenges200(int challengeOrder) {
                 "GET /challenges (200)",
                 "Issue a GET request on the `/challenges` end point");
 
+        aChallenge.addHint("Remember to add the X-CHALLENGER header so you see the progress of the challenges for your session.", "");
+        aChallenge.addHint("If you issue a GET request without an X-CHALLENGER header you will see the default challenge values.", "");
+        aChallenge.addHint("By default the response body will be JSON format.", "");
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/first-challenge/get-challenges-200");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "DrAjk2NaPRo");
 
@@ -23,6 +27,10 @@ public static ChallengeDefinitionData getTodos200(int challengeOrder) {
                 "GET /todos (200)",
                 "Issue a GET request on the `/todos` end point");
 
+        aChallenge.addHint("Remember to add the X-CHALLENGER header so you see the data for your session.", "");
+        aChallenge.addHint("If you issue a GET request without an X-CHALLENGER header you will see the default todo values.", "");
+        aChallenge.addHint("By default the response body will be JSON format.", "");
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/get/get-todos-200");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "OpisB0UZq0c");
 
@@ -35,6 +43,7 @@ public static ChallengeDefinitionData getTodos404(int challengeOrder) {
                 "GET /todo (404) not plural",
                 "Issue a GET request on the `/todo` end point should 404 because nouns should be plural");
 
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/get/get-todo-404");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "gAJzqgcN9dc");
 
@@ -48,6 +57,7 @@ public static ChallengeDefinitionData getTodo200(int challengeOrder) {
                 "Issue a GET request on the `/todos/{id}` end point to return a specific todo");
 
         aChallenge.addHint("Make sure you don't use {id} in the url, replace that with the id of a todo e.g. /todos/1");
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/get/get-todos-id-200");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "JDbbSY3U_rY");
 
@@ -63,6 +73,7 @@ public static ChallengeDefinitionData getTodo404(int challengeOrder) {
         aChallenge.addHint("Make sure you don't use {id} in the url, replace that with the id of a todo e.g. /todos/1");
         aChallenge.addHint("Make sure the id is an integer e.g. /todos/1");
         aChallenge.addHint("Make sure you are using the /todos end point e.g. /todos/1");
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/get/get-todos-id-404");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "1S5kpd8-xfM");
 
@@ -74,10 +85,12 @@ public static ChallengeDefinitionData getTodosFiltered200(int challengeOrder) {
                 ChallengeRenderer.renderChallengeNumber(challengeOrder),
                 "GET /todos (200) ?filter",
                 "Issue a GET request on the `/todos` end point with a query filter to get only todos which are 'done'. There must exist both 'done' and 'not done' todos, to pass this challenge.");
+
         aChallenge.addHint("A query filter is a URL parameter using the field name and a value");
         aChallenge.addHint("A URL parameter is added to the end of a url with a ? e.g. /todos?id=1");
         aChallenge.addHint("To filter on 'done' we use the 'doneStatus' field  ? e.g. ?doneStatus=true");
         aChallenge.addHint("Make sure there are todos which are done, and not yet done");
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/get/get-todos-200-filter");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "G-sLuhyPMuw");
         return aChallenge;

challenger/src/main/java/uk/co/compendiumdev/challenge/challenges/definitions/PostChallenges.java

@@ -1,6 +1,5 @@
 package uk.co.compendiumdev.challenge.challenges.definitions;
 
-import uk.co.compendiumdev.challenge.CHALLENGE;
 import uk.co.compendiumdev.challenge.challenges.ChallengeDefinitionData;
 
 public class PostChallenges {
@@ -16,6 +15,11 @@ public static ChallengeDefinitionData postTodos201(int challengeOrder) {
                 "POST /todos (201)",
                 "Issue a POST request to successfully create a todo");
 
+        aChallenge.addHint("Add a JSON payload in the request", "");
+        aChallenge.addHint("If you don't know the format of the payload, use the response from a GET /todos/{id} request and amend it", "");
+        aChallenge.addHint("You must add an X-CHALLENGER header for a valid session", "");
+
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/post-create/post-todos-201");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "T0LFHwavsNA");
         return aChallenge;
@@ -40,6 +44,8 @@ public static ChallengeDefinitionData postTodosBadDoneStatus400(int challengeOrd
                 "POST /todos (400) doneStatus",
                 "Issue a POST request to create a todo but fail validation on the `doneStatus` field");
 
+        aChallenge.addHint("doneStatus should be boolean, an invalid status would be a String or a number e.g. \"invalid\"");
+
         aChallenge.addSolutionLink("Read Solution", "HREF", "/apichallenges/solutions/post-create/post-todos-400");
         aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "tlye5bQ72g0");
         return aChallenge;

challenger/src/main/java/uk/co/compendiumdev/challenge/challenges/definitions/PutChallenges.java

@@ -10,6 +10,11 @@ public static ChallengeDefinitionData putTodosId400(int challengeOrder) {
                 "PUT /todos/{id} (400)",
                 "Issue a PUT request to unsuccessfully create a todo");
 
+        aChallenge.addHint("Add a JSON payload in the request", "");
+        aChallenge.addHint("If you don't know the format of the payload, use the response from a GET /todos/{id} request and amend it", "");
+        aChallenge.addHint("Do not include an 'id' in the payload", "");
+        aChallenge.addHint("You must add an X-CHALLENGER header for a valid session", "");
+
         // todo: create solution for PUT todos 400 challenge
         //aChallenge.addSolutionLink("Read Solution", "HREF", "https://www.eviltester.com/apichallenges/howto/post-todos-201");
         //aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "T0LFHwavsNA");
@@ -26,6 +31,10 @@ public static ChallengeDefinitionData putTodosIdFull200(int challengeOrder) {
                 "PUT /todos/{id} full (200)",
                 "Issue a PUT request to update an existing todo with a complete payload i.e. title, description and donestatus.");
 
+        aChallenge.addHint("Add a JSON payload in the request", "");
+        aChallenge.addHint("If you don't know the format of the payload, use the response from a GET /todos/{id} request and amend it", "");
+        aChallenge.addHint("Do not include an 'id' in the payload", "");
+
         // todo: create solution for PUT todos full 200 challenge
         //aChallenge.addSolutionLink("Read Solution", "HREF", "https://www.eviltester.com/apichallenges/howto/post-todos-201");
         //aChallenge.addSolutionLink("Watch Insomnia Solution", "YOUTUBE", "T0LFHwavsNA");

challenger/src/main/resources/content/practice-modes/simulation.md

@@ -250,7 +250,7 @@ To find out what Verbs, or Methods, we are allowed to use, issue an `OPTIONS` re
 OPTIONS {{<ORIGIN_URL>}}/sim/entities
 ```
 
-By looking at the `Accept` header in the response we can see that we are allowed to `GET, POST, PUT, HEAD, OPTIONS`
+By looking at the `Allow` header in the response we can see that we are allowed to `GET, POST, PUT, HEAD, OPTIONS`
 
 If we tried to `DELETE` or `PATCH` then we should receive an appropriate status code of `405`
 

challengerAuto/pom.xml

@@ -36,6 +36,12 @@
             <version>${junit.jupiter.version}</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-params</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
 
         <dependency>
             <groupId>io.rest-assured</groupId>