feat: add venom tests with smocker

gwleclerc · gwleclerc · commit 60db0c1f8fdb · 2022-12-01T01:15:11.000+01:00
diff --git a/Makefile b/Makefile
@@ -37,15 +37,15 @@ test:
 .PHONY: test-integration
 test-integration: $(VENOM)
 	. .env; \
-	$(VENOM) run venom/**/*.venom.yml --var="myapp=$${MY_APP}" --var="pgsql_dsn=$${POSTGRES_DSN}"  --format=xml --output-dir=./dist
+	$(VENOM) run venom/**/*.venom.yml --var="myapp=$${MY_APP}" --var="mock_server=$${MOCK_SERVER_ADMIN}" --var="pgsql_dsn=$${POSTGRES_DSN}"  --format=xml --output-dir=./dist
 
 .PHONY: integration
 PID_FILE:=/tmp/example.test.pid
 integration: build $(VENOM)
 	. .env; \
 	./dist/example.test -test.coverprofile=./dist/example.venom.cover.out > ./dist/example.app.log 2>&1 & echo $$! > $(PID_FILE); \
 	sleep 5; \
-	$(VENOM) run venom/**/*.venom.yml --var="myapp=$${MY_APP}" --var="pgsql_dsn=$${POSTGRES_DSN}" --format=xml --output-dir=./dist | tee ./dist/example.venom.log 2>&1 || res=$$?; \
+	$(VENOM) run venom/**/*.venom.yml --var="myapp=$${MY_APP}" --var="mock_server=$${MOCK_SERVER_ADMIN}" --var="pgsql_dsn=$${POSTGRES_DSN}" --format=xml --output-dir=./dist | tee ./dist/example.venom.log 2>&1 || res=$$?; \
 	kill `cat $(PID_FILE)` 2> /dev/null || true; \
 	go tool cover -html=./dist/example.venom.cover.out -o ./dist/example.venom.cover.html; \
 	exit $$res
diff --git a/sdks/hotels.go b/sdks/hotels.go
@@ -32,6 +32,9 @@ func (c *hotelsClient) GetHotels(ctx context.Context) ([]types.Hotel, error) {
 		return hotels, err
 	}
 	defer resp.Body.Close()
+	if err = errorHook(resp); err != nil {
+		return hotels, err
+	}
 	err = json.NewDecoder(resp.Body).Decode(&hotels)
 	return hotels, err
 }
@@ -47,6 +50,9 @@ func (c *hotelsClient) GetHotelByName(ctx context.Context, name string) (types.H
 		return hotel, err
 	}
 	defer resp.Body.Close()
+	if err = errorHook(resp); err != nil {
+		return hotel, err
+	}
 	err = json.NewDecoder(resp.Body).Decode(&hotel)
 	return hotel, err
 }
diff --git a/sdks/sdks.go b/sdks/sdks.go
@@ -0,0 +1,29 @@
+package sdks
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+)
+
+type SDKError struct {
+	Code    int    `json:"code"`
+	Message string `json:"message"`
+}
+
+func (m *SDKError) Error() string {
+	return fmt.Sprintf("request failed with code %d: %s", m.Code, m.Message)
+}
+
+func errorHook(resp *http.Response) error {
+	if resp.StatusCode < 400 {
+		return nil
+	}
+	var errSDK SDKError
+	err := json.NewDecoder(resp.Body).Decode(&errSDK)
+	if err != nil {
+		return &SDKError{Code: resp.StatusCode, Message: err.Error()}
+	}
+	errSDK.Code = resp.StatusCode
+	return &errSDK
+}
diff --git a/sdks/users.go b/sdks/users.go
@@ -32,6 +32,9 @@ func (c *usersClient) GetUsers(ctx context.Context) ([]types.User, error) {
 		return users, err
 	}
 	defer resp.Body.Close()
+	if err = errorHook(resp); err != nil {
+		return users, err
+	}
 	err = json.NewDecoder(resp.Body).Decode(&users)
 	return users, err
 }
@@ -47,6 +50,9 @@ func (c *usersClient) GetUserByName(ctx context.Context, name string) (types.Use
 		return user, err
 	}
 	defer resp.Body.Close()
+	if err = errorHook(resp); err != nil {
+		return user, err
+	}
 	err = json.NewDecoder(resp.Body).Decode(&user)
 	return user, err
 }
diff --git a/server/server.go b/server/server.go
@@ -22,8 +22,9 @@ func Serve(config types.Config) {
 
 	engine := echo.New()
 	engine.Use(middleware.Recover(), middleware.LoggerWithConfig(middleware.LoggerConfig{
-		Format: "method=${method}, uri=${uri}, status=${status}\n",
+		Format: "HTTP Request time=${time_rfc3339}, method=${method}, uri=${uri}, status=${status}\n",
 	}))
+
 	reservations := engine.Group("/reservations")
 	{
 		ctrl := ctrls.Reservations
diff --git a/server/services/services.go b/server/services/services.go
@@ -61,15 +61,15 @@ func (s *reservations) CreateReservation(ctx context.Context, reservation types.
 	var res types.Reservation
 	user, err := s.users.GetUserByName(ctx, reservation.User)
 	if err != nil {
-		return res, err
+		return res, fmt.Errorf("unable to retrieve user %q: %w", reservation.User, err)
 	}
 	hotel, err := s.hotels.GetHotelByName(ctx, reservation.Hotel)
 	if err != nil {
-		return res, err
+		return res, fmt.Errorf("unable to retrieve hotel %q: %w", reservation.Hotel, err)
 	}
 	reservations, err := s.db.SelectReservationsByHotel(ctx, hotel.ID)
 	if err != nil {
-		return res, err
+		return res, fmt.Errorf("unable to retrieve reservations from database: %w", err)
 	}
 
 	reservedRooms := int64(0)
@@ -81,9 +81,13 @@ func (s *reservations) CreateReservation(ctx context.Context, reservation types.
 		return res, fmt.Errorf("can't create reservation: %w", ErrInsufficientCapacity)
 	}
 
-	return s.db.InsertReservation(ctx, types.Reservation{
+	result, err := s.db.InsertReservation(ctx, types.Reservation{
 		UserID:     user.ID,
 		HotelID:    hotel.ID,
 		RoomNumber: reservation.Rooms,
 	})
+	if err != nil {
+		return res, fmt.Errorf("unable to create reservation on database: %w", err)
+	}
+	return result, nil
 }
diff --git a/venom/assets/fixtures/reservations.yml b/venom/assets/fixtures/reservations.yml
@@ -9,4 +9,8 @@
 - id: 3
   user_id: 1
   hotel_id: 3
+  room_number: 2
+- id: 4
+  user_id: 1
+  hotel_id: 1
   room_number: 2
diff --git a/venom/assets/mocks/create_reservation_not_found.mocks.yml b/venom/assets/mocks/create_reservation_not_found.mocks.yml
@@ -0,0 +1,36 @@
+# UC 1
+- request:
+    path: /users/user1
+    method: GET
+  response:
+    status: 404
+    headers:
+      Content-Type: application/json
+    body: >
+      {
+        "message": "not found"
+      }
+
+# UC 2
+- request:
+    path: /users/user2
+    method: GET
+  response:
+    headers:
+      Content-Type: application/json
+    body: >
+      {
+        "id": 2,
+        "name": "user2"
+      }
+- request:
+    path: /hotels/hotel2
+    method: GET
+  response:
+    status: 404
+    headers:
+      Content-Type: application/json
+    body: >
+      {
+        "message": "not found"
+      }
diff --git a/venom/assets/mocks/create_reservation_ok.mocks.yml b/venom/assets/mocks/create_reservation_ok.mocks.yml
@@ -0,0 +1,23 @@
+- request:
+    path: /users/user1
+    method: GET
+  response:
+    headers:
+      Content-Type: application/json
+    body: >
+      {
+        "id": 1,
+        "name": "user1"
+      }
+- request:
+    path: /hotels/hotel1
+    method: GET
+  response:
+    headers:
+      Content-Type: application/json
+    body: >
+      {
+        "id": 1,
+        "name": "hotel1",
+        "rooms": 10
+      }
diff --git a/venom/reservations.venom.yml b/venom/reservations.venom.yml
@@ -11,7 +11,7 @@ testcases:
         assertions:
           - result.err ShouldBeEmpty
 
-  - name: Retrieve reservations
+  - name: Retrieve existings reservations
     steps:
       - type: http
         method: GET
@@ -21,7 +21,7 @@ testcases:
           - result.bodyjson.__type__ ShouldEqual Array
           - result.bodyjson.__len__ ShouldEqual 3
 
-  - name: Retrieve one existing reservation
+  - name: Retrieve an existing reservation
     steps:
       - type: http
         method: GET
@@ -33,23 +33,95 @@ testcases:
           - result.bodyjson.hotel_id ShouldEqual 2
           - result.bodyjson.room_number ShouldEqual 3
 
-  - name: Try to retrieve unexisting reservation
+  - name: Try to retrieve an unexisting reservation
     steps:
       - type: http
         method: GET
-        url: "{{.myapp}}/reservations/4"
+        url: "{{.myapp}}/reservations/5"
         assertions:
           - result.statuscode ShouldEqual 404
-          - "result.bodyjson.message ShouldEqual unable to retrieve reservation for id '4': not found"
+          - "result.bodyjson.message ShouldEqual unable to retrieve reservation for id '5': not found"
 
-  - name: Get one reservation
+  - name: Create a reservation with missing data
     steps:
       - type: http
-        method: GET
-        url: "{{.myapp}}/reservations/1"
+        method: POST
+        url: "{{.mock_server}}/mocks?session=create_reservation_missing_data"
+        bodyFile: ./assets/mocks/create_reservation_not_found.mocks.yml
         assertions:
           - result.statuscode ShouldEqual 200
-          - result.bodyjson.id ShouldEqual 1
-          - result.bodyjson.user_id ShouldEqual 2
-          - result.bodyjson.hotel_id ShouldEqual 2
-          - result.bodyjson.room_number ShouldEqual 3
+      - type: http
+        method: POST
+        url: "{{.myapp}}/reservations"
+        headers:
+          Content-Type: application/json
+        body: |
+          {
+            "hotel": "hotel1",
+            "user":  "user1",
+            "rooms": 2
+          }
+        assertions:
+          - result.statuscode ShouldEqual 500
+          - 'result.bodyjson.message ShouldEqual unable to retrieve user "user1": request failed with code 404: not found'
+      - type: http
+        method: POST
+        url: "{{.myapp}}/reservations"
+        headers:
+          Content-Type: application/json
+        body: |
+          {
+            "hotel": "hotel2",
+            "user":  "user2",
+            "rooms": 2
+          }
+        assertions:
+          - result.statuscode ShouldEqual 500
+          - 'result.bodyjson.message ShouldEqual unable to retrieve hotel "hotel2": request failed with code 404: not found'
+
+  - name: Create a reservation not enough rooms
+    steps:
+      - type: http
+        method: POST
+        url: "{{.mock_server}}/mocks?session=create_reservation_not_enough_rooms"
+        bodyFile: ./assets/mocks/create_reservation_ok.mocks.yml
+        assertions:
+          - result.statuscode ShouldEqual 200
+      - type: http
+        method: POST
+        url: "{{.myapp}}/reservations"
+        headers:
+          Content-Type: application/json
+        body: |
+          {
+            "hotel": "hotel1",
+            "user":  "user1",
+            "rooms": 20
+          }
+        assertions:
+          - result.statuscode ShouldEqual 409
+          - "result.bodyjson.message ShouldEqual can't create reservation: not enough room available"
+
+  - name: Create a reservation ok
+    steps:
+      - type: http
+        method: POST
+        url: "{{.mock_server}}/mocks?session=create_reservation_ok"
+        bodyFile: ./assets/mocks/create_reservation_ok.mocks.yml
+        assertions:
+          - result.statuscode ShouldEqual 200
+      - type: http
+        method: POST
+        url: "{{.myapp}}/reservations"
+        headers:
+          Content-Type: application/json
+        body: |
+          {
+            "hotel": "hotel1",
+            "user":  "user1",
+            "rooms": 2
+          }
+        assertions:
+          - result.statuscode ShouldEqual 200
+          - result.bodyjson.id ShouldNotBeEmpty
+

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ func (c *hotelsClient) GetHotels(ctx context.Context) ([]types.Hotel, error) {`
`32`	`32`	`return hotels, err`
`33`	`33`	`}`
`34`	`34`	`defer resp.Body.Close()`
	`35`	`+ if err = errorHook(resp); err != nil {`
	`36`	`+ return hotels, err`
	`37`	`+ }`
`35`	`38`	`err = json.NewDecoder(resp.Body).Decode(&hotels)`
`36`	`39`	`return hotels, err`
`37`	`40`	`}`
`@@ -47,6 +50,9 @@ func (c *hotelsClient) GetHotelByName(ctx context.Context, name string) (types.H`
`47`	`50`	`return hotel, err`
`48`	`51`	`}`
`49`	`52`	`defer resp.Body.Close()`
	`53`	`+ if err = errorHook(resp); err != nil {`
	`54`	`+ return hotel, err`
	`55`	`+ }`
`50`	`56`	`err = json.NewDecoder(resp.Body).Decode(&hotel)`
`51`	`57`	`return hotel, err`
`52`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ func (c *usersClient) GetUsers(ctx context.Context) ([]types.User, error) {`
`32`	`32`	`return users, err`
`33`	`33`	`}`
`34`	`34`	`defer resp.Body.Close()`
	`35`	`+ if err = errorHook(resp); err != nil {`
	`36`	`+ return users, err`
	`37`	`+ }`
`35`	`38`	`err = json.NewDecoder(resp.Body).Decode(&users)`
`36`	`39`	`return users, err`
`37`	`40`	`}`
`@@ -47,6 +50,9 @@ func (c *usersClient) GetUserByName(ctx context.Context, name string) (types.Use`
`47`	`50`	`return user, err`
`48`	`51`	`}`
`49`	`52`	`defer resp.Body.Close()`
	`53`	`+ if err = errorHook(resp); err != nil {`
	`54`	`+ return user, err`
	`55`	`+ }`
`50`	`56`	`err = json.NewDecoder(resp.Body).Decode(&user)`
`51`	`57`	`return user, err`
`52`	`58`	`}`