Skip to content

Commit 9f2e2a0

Browse files
author
pawel.chmielewski
committed
feature: Updated links
1 parent cf86dad commit 9f2e2a0

File tree

3 files changed

+27
-27
lines changed

3 files changed

+27
-27
lines changed

README.MD

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
![godog-example-setup](https://github.com/pawelWritesCode/godog-example-setup/actions/workflows/go.yml/badge.svg)
1+
![godog-example-setup](https://github.com/pawelWritesCode/godog-http-api/actions/workflows/go.yml/badge.svg)
22

33
# Godog framework developed to test HTTP(s) API.
44

55
## Overview:
66

77
This repository contains skeleton that allow to write End-2-End tests for HTTP(s) API with use of framework [godog](https://github.com/cucumber/godog)
8-
that implements 🥒[cucumber/gherkin](https://cucumber.io/docs/gherkin/) syntax using step library [gdutils](https://github.com/pawelWritesCode/gdutils).
8+
that implements 🥒[cucumber/gherkin](https://cucumber.io/docs/gherkin/) syntax using testing library [gdutils](https://github.com/pawelWritesCode/gdutils).
99

1010
## Why ?
1111
This project **cuts initial time** & allows bootstrap e2e test framework with **plenty of
1212
utility methods** in just few steps. Just grab it and write tests right away!
1313

1414
Benefits:
15-
* [35+ well-documented, coupled in logical groups steps](https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps) useful for testing HTTP(s) API,
15+
* [35+ well-documented, coupled in logical groups steps](https://github.com/pawelWritesCode/godog-http-api/wiki/Steps) useful for testing HTTP(s) API,
1616
* support for using templated values as in [text/template](https://pkg.go.dev/text/template) package,
1717
* support for querying nodes with different path engines ([oliveagle](https://github.com/oliveagle/jsonpath), [qjson](https://github.com/pawelWritesCode/qjson) - JSON, [go-yaml](https://github.com/goccy/go-yaml) - YAML, [antchfx](https://github.com/antchfx/xmlquery) - XML),
1818
* support for sending _multipart/form-data_ forms with file in it,
1919
* developed with debugging in mind,
20-
* customisable through ability to [replace](https://github.com/pawelWritesCode/godog-example-setup/blob/main/main_test.go#L58) utility services with your own implementations,
21-
* supports [custom steps development](https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps-development).
20+
* customisable through ability to [replace](https://github.com/pawelWritesCode/godog-http-api/blob/main/main_test.go#L53) utility services with your own implementations,
21+
* supports [custom steps development](https://github.com/pawelWritesCode/godog-http-api/wiki/Steps-development).
2222

2323
## Example
2424

25-
#### [👆 Click here to see more tests using JSON/YAML/XML](https://github.com/pawelWritesCode/godog-example-setup/blob/main/features/test_server)
25+
#### [👆 Click here to see more tests using JSON/YAML/XML](https://github.com/pawelWritesCode/godog-http-api/blob/main/features/test_server)
2626

2727
```cucumber
2828
Feature: Adding new user
@@ -90,7 +90,7 @@ Feature: Adding new user
9090
# or full OS path
9191
And the response body should be valid according to schema "{{.CWD}}/assets/test_server/doc/schema/user/user.json"
9292
# or URL pointing at schema
93-
And the response body should be valid according to schema "https://raw.githubusercontent.com/pawelWritesCode/godog-example-setup/main/assets/test_server/doc/schema/user/user.json"
93+
And the response body should be valid according to schema "https://raw.githubusercontent.com/pawelWritesCode/godog-http-api/main/assets/test_server/doc/schema/user/user.json"
9494
# or raw schema definition passed in Docstring
9595
And the response body should be valid according to schema:
9696
"""
@@ -127,12 +127,12 @@ Feature: Adding new user
127127

128128
## Documentation
129129

130-
See project ![hand pointing right](assets/gifs/hand-pointing-right.gif) [wiki](https://github.com/pawelWritesCode/godog-example-setup/wiki) ![hand pointing left](assets/gifs/hand-pointing-left.gif)
130+
See project ![hand pointing right](assets/gifs/hand-pointing-right.gif) [wiki](https://github.com/pawelWritesCode/godog-http-api/wiki) ![hand pointing left](assets/gifs/hand-pointing-left.gif)
131131

132-
* [Overview](https://github.com/pawelWritesCode/godog-example-setup/wiki/Overview) - general information about project,
133-
* [Project structure](https://github.com/pawelWritesCode/godog-example-setup/wiki/Project-structure) - describes repository folder structure,
134-
* [Setup](https://github.com/pawelWritesCode/godog-example-setup/wiki/Set-up) - guide how to bootstrap repository on your machine,
135-
* [Steps](https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps) - describes each available step and how to use it in tests,
136-
* [Steps debugging](https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps-debugging) - how to debug tests,
137-
* [Steps development](https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps-development) - how to create custom steps using utility services,
138-
* [Usage](https://github.com/pawelWritesCode/godog-example-setup/wiki/Usage) - how to run tests.
132+
* [Overview](https://github.com/pawelWritesCode/godog-http-api/wiki/Overview) - general information about project,
133+
* [Project structure](https://github.com/pawelWritesCode/godog-http-api/wiki/Project-structure) - describes repository folder structure,
134+
* [Setup](https://github.com/pawelWritesCode/godog-http-api/wiki/Set-up) - guide how to bootstrap repository on your machine,
135+
* [Steps](https://github.com/pawelWritesCode/godog-http-api/wiki/Steps) - describes each available step and how to use it in tests,
136+
* [Steps debugging](https://github.com/pawelWritesCode/godog-http-api/wiki/Steps-debugging) - how to debug tests,
137+
* [Steps development](https://github.com/pawelWritesCode/godog-http-api/wiki/Steps-development) - how to create custom steps using utility services,
138+
* [Usage](https://github.com/pawelWritesCode/godog-http-api/wiki/Usage) - how to run tests.

features/test_server/json/create.feature

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Feature: Adding new user
6363
# or full OS path
6464
And the response body should be valid according to schema "{{.CWD}}/assets/test_server/doc/schema/user/user.json"
6565
# or URL pointing at schema
66-
And the response body should be valid according to schema "https://raw.githubusercontent.com/pawelWritesCode/godog-example-setup/main/assets/test_server/doc/schema/user/user.json"
66+
And the response body should be valid according to schema "https://raw.githubusercontent.com/pawelWritesCode/godog-http-api/main/assets/test_server/doc/schema/user/user.json"
6767
# or raw schema definition passed in Docstring
6868
And the response body should be valid according to schema:
6969
"""

main_test.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ import (
1919
)
2020

2121
const (
22-
//envDebug describes environment variable responsible for debug mode - (true/false)
22+
//envDebug describes environment variable responsible for debug mode - (true/false).
2323
envDebug = "GODOG_DEBUG"
2424

25-
// envMyAppURL describes URL to "My app" - should be valid URL
25+
// envMyAppURL describes URL to "My app" - should be valid URL.
2626
envMyAppURL = "GODOG_MY_APP_URL"
2727

28-
// envJsonSchemaDir path to JSON schemas dir - relative path from project root
28+
// envJsonSchemaDir path to JSON schemas dir - relative path from this file's directory.
2929
envJsonSchemaDir = "GODOG_JSON_SCHEMA_DIR"
3030
)
3131

@@ -54,7 +54,7 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
5454
scenario is entity that contains utility services and holds methods used behind godog steps.
5555
5656
If you would like to replace any of default state's utility services with your own, read:
57-
https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps-development#utilityServices
57+
https://github.com/pawelWritesCode/godog-http-api/wiki/Steps-development#utilityServices
5858
*/
5959
scenario := defs.Scenario{APIContext: gdutils.NewDefaultAPIContext(isDebug, path.Join(wd, os.Getenv(envJsonSchemaDir)))}
6060

@@ -69,11 +69,11 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
6969
})
7070

7171
// Following declarations maps sentences to methods (define steps). To learn more on each step see
72-
// https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps
72+
// https://github.com/pawelWritesCode/godog-http-api/wiki/Steps
7373

7474
/*
7575
|----------------------------------------------------------------------------------------------------------------
76-
| Random data generation - https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps#data-generation
76+
| Random data generation - https://github.com/pawelWritesCode/godog-http-api/wiki/Steps#dataGeneration
7777
|----------------------------------------------------------------------------------------------------------------
7878
|
7979
| This section contains utility methods for random data generation. Those methods contain creation of
@@ -93,7 +93,7 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
9393

9494
/*
9595
|----------------------------------------------------------------------------------------------------------------
96-
| Sending HTTP(s) requests - https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps#sending-https-requests
96+
| Sending HTTP(s) requests - https://github.com/pawelWritesCode/godog-http-api/wiki/Steps#httpRequest
9797
|----------------------------------------------------------------------------------------------------------------
9898
|
9999
| This section contains methods for preparing and sending HTTP(s) requests.
@@ -122,7 +122,7 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
122122

123123
/*
124124
|----------------------------------------------------------------------------------------------------------------
125-
| Assertions - https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps#assertions
125+
| Assertions - https://github.com/pawelWritesCode/godog-http-api/wiki/Steps#assertions
126126
|----------------------------------------------------------------------------------------------------------------
127127
|
128128
| This section contains assertions against last HTTP(s) responses, especially:
@@ -172,7 +172,7 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
172172

173173
/*
174174
|----------------------------------------------------------------------------------------------------------------
175-
| Preserving data - https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps#preserving-data
175+
| Preserving data - https://github.com/pawelWritesCode/godog-http-api/wiki/Steps#preservingData
176176
|----------------------------------------------------------------------------------------------------------------
177177
|
178178
| This section contains method for preserving data in scenario cache
@@ -189,7 +189,7 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
189189

190190
/*
191191
|----------------------------------------------------------------------------------------------------------------
192-
| Debugging - https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps#debugging
192+
| Debugging - https://github.com/pawelWritesCode/godog-http-api/wiki/Steps#debugging
193193
|----------------------------------------------------------------------------------------------------------------
194194
|
195195
| This section contains methods that are useful for debugging during test creation phase.
@@ -200,7 +200,7 @@ func InitializeScenario(ctx *godog.ScenarioContext) {
200200

201201
/*
202202
|----------------------------------------------------------------------------------------------------------------
203-
| Flow control - https://github.com/pawelWritesCode/godog-example-setup/wiki/Steps#flow-control
203+
| Flow control - https://github.com/pawelWritesCode/godog-http-api/wiki/Steps#flowControl
204204
|----------------------------------------------------------------------------------------------------------------
205205
|
206206
| This section contains methods for control scenario flow.

0 commit comments

Comments
 (0)