Skip to content

Commit 9226d57

Browse files
committed
feat(cli): Add consistent description for all playbooks
1 parent cbd88b8 commit 9226d57

93 files changed

Lines changed: 118 additions & 138 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/main/java/dev/dochia/cli/core/playbook/body/BypassAuthenticationPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,6 @@ public String toString() {
8282

8383
@Override
8484
public String description() {
85-
return "check if an authentication header is supplied; if yes try to make requests without it";
85+
return " Check if authentication headers are supplied and attempt requests without them";
8686
}
8787
}

src/main/java/dev/dochia/cli/core/playbook/body/CustomHttpMethodsPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public void run(PlaybookData data) {
4040

4141
@Override
4242
public String description() {
43-
return "iterate through a list of hypothetical HTTP methods that are not expected to be implemented by REST APIs";
43+
return "Iterate through hypothetical HTTP methods not expected in REST APIs";
4444
}
4545

4646
@Override

src/main/java/dev/dochia/cli/core/playbook/body/DummyRequestPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ protected String getPayload(PlaybookData data) {
3636

3737
@Override
3838
public String description() {
39-
return "send a dummy json request {'dochia': 'dochia'}";
39+
return "Send dummy JSON request {'dochia': 'dochia'}";
4040
}
4141
}

src/main/java/dev/dochia/cli/core/playbook/body/EmptyBodyPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ protected String getPayload(PlaybookData data) {
3535

3636
@Override
3737
public String description() {
38-
return "send a request with a empty string body";
38+
return "Send request with empty string body";
3939
}
4040
}

src/main/java/dev/dochia/cli/core/playbook/body/EmptyJsonArrayBodyPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ protected String getPayload(PlaybookData data) {
3535

3636
@Override
3737
public String description() {
38-
return "send a request with a empty json array body";
38+
return "Send request with empty JSON array body";
3939
}
4040
}

src/main/java/dev/dochia/cli/core/playbook/body/EmptyJsonBodyPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ protected String getPayload(PlaybookData data) {
3535

3636
@Override
3737
public String description() {
38-
return "send a request with a empty json body";
38+
return "Send request with empty JSON object body";
3939
}
4040
}

src/main/java/dev/dochia/cli/core/playbook/body/HappyPathPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,6 @@ public String toString() {
5050

5151
@Override
5252
public String description() {
53-
return "send a request with all fields and headers populated";
53+
return "Send request with all fields and headers properly populated";
5454
}
5555
}

src/main/java/dev/dochia/cli/core/playbook/body/HttpMethodPlaybookUtil.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public void process(TestCasePlaybook testCasePlaybook, PlaybookData data, HttpMe
5353
.testCasePlaybook(testCasePlaybook)
5454
.expectedSpecificResponseCode("405")
5555
.payload(HttpMethod.requiresBody(httpMethod) ? data.getPayload() : "")
56-
.scenario("Send a happy flow request with undocumented HTTP method: %s".formatted(httpMethod))
56+
.scenario("Send a happy path request with undocumented HTTP method: %s".formatted(httpMethod))
5757
.responseProcessor(this::checkResponse)
5858
.playbookData(data)
5959
.httpMethod(httpMethod)

src/main/java/dev/dochia/cli/core/playbook/body/HttpMethodsPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,6 @@ public String toString() {
6767

6868
@Override
6969
public String description() {
70-
return "iterate through each undocumented HTTP method and send an empty request";
70+
return "Iterate through each undocumented HTTP method and send empty request";
7171
}
7272
}

src/main/java/dev/dochia/cli/core/playbook/body/InsertRandomValuesInBodyPlaybook.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public void run(PlaybookData data) {
5959

6060
@Override
6161
public String description() {
62-
return "insert invalid data within a valid request body";
62+
return "Insert invalid data within a valid request body";
6363
}
6464

6565
@Override

0 commit comments

Comments
 (0)