Orders Microservice and Test Suite

Overview

This repository contains a simple Orders microservice built with Node.js and Express, along with a test script to verify its functionality. The service allows clients to create, retrieve, and update orders, which consist of an orderId, userId, status (either open or complete), and a JSON array of order items.

Prerequisites

• Node.js (v14+)

• npm

Installation

Clone the repository:

git clone https://github.com/cohenvelazquez/CS361_microTyler.git

cd CS361_microTyler/

Install dependencies:

npm install

Usage

Running the Service

Start the orders microservice on the default port (3000):

node checkout.js

You should see:

Orders microservice listening on http://localhost:3000

API Endpoints

Create a New Order

• URL: POST /orders

• Body:

{
  "userId": "string",
  "items": [
    { "productId": "string", "quantity": number, "price": number },
    ...
  ]
}

• Response: 201 Created

{
  "orderId": "uuid",
  "userId": "string",
  "status": "open",
  "items": [ ... ]
}

Retrieve an Order

• URL: GET /orders/:orderId

• Response: 200 OK

{
  "orderId": "uuid",
  "userId": "string",
  "status": "open" | "complete",
  "items": [ ... ]
}

• Error: 404 Not Found if order does not exist.

Update an Order

• URL: PUT /orders/:orderId

• Body (any combination):

{
  "status": "open" | "complete",
  "items": [ ... ]
}

• Response: 200 OK with the updated order object.

• Error: 400 Bad Request for invalid status, 404 Not Found if order not found.

Testing

A simple test script (testOrders.js) uses axios to validate each endpoint in sequence.

Setup

Install axios:

npm install axios

Run Tests

With the server running, execute:

node testOrders.js

This will:

1. POST /orders – create a new order and log its orderId.

2. GET /orders/:orderId – retrieve and display the order.

3. PUT /orders/:orderId – update the status to complete.

4. PUT /orders/:orderId – modify the items array.

5. GET /orders/:orderId – final sanity-check.

If any request fails, the script will log an error and exit with code 1.

UML Diagram

sequenceDiagram
    participant Client
    participant OrdersService
    participant Database

    opt Create Order
        Client->>OrdersService: POST /orders { userId, items }
        activate OrdersService
        OrdersService->>OrdersService: validate payload
        alt valid payload
            OrdersService->>Database: createOrder(...)
            activate Database
            Database-->>OrdersService: OrderData
            deactivate Database
            OrdersService-->>Client: 201 Created { order JSON }
        else invalid payload
            OrdersService-->>Client: 400 Bad Request { error }
        end
        deactivate OrdersService
    end

    opt Retrieve Order
        Client->>OrdersService: GET /orders/{orderId}
        activate OrdersService
        OrdersService->>Database: findOrder(orderId)
        activate Database
        Database-->>OrdersService: OrderData?
        deactivate Database
        alt order found
            OrdersService-->>Client: 200 OK { order JSON }
        else not found
            OrdersService-->>Client: 404 Not Found { error }
        end
        deactivate OrdersService
    end

    opt Update Order
        Client->>OrdersService: PUT /orders/{orderId} { status?, items? }
        activate OrdersService
        OrdersService->>OrdersService: validate status
        alt invalid status
            OrdersService-->>Client: 400 Bad Request { error }
        else status OK
            OrdersService->>Database: updateOrder(...)
            activate Database
            Database-->>OrdersService: UpdatedOrder?
            deactivate Database
            alt order exists
                OrdersService-->>Client: 200 OK { updated order JSON }
            else not found
                OrdersService-->>Client: 404 Not Found { error }
            end
        end
        deactivate OrdersService
    end

Loading