test: Add API collection

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: taiki-e/install-action@dprint
       - uses: taiki-e/install-action@v2
         with:
-          tool: typos-cli
+          tool: typos-cli,hurlfmt
 
       - name: Check MSRV
         run: |

docs/dev/README.md

@@ -26,4 +26,11 @@ This repo is using [Agular's commit message format][commit-message]
 - Run `just up` to check for outdated dependencies, and then run `just up --write` to update them.
 - Upgrade the `cargo-chef` version in the `Dockerfile`.
 
+## Running API collection
+
+```shell
+hurl --variables-file props/local meta/meta.hurl | jq
+hurl --variables-file props/local meta/meta.hurl --ignore-asserts | jq
+```
+
 [commit-message]: https://github.com/angular/angular/blob/2095a08781167e91a60a4cec65c694688b319cd0/CONTRIBUTING.md#-commit-message-format

justfile

@@ -54,11 +54,13 @@ image-restart:
 fmt:
     cargo fmt --all
     dprint fmt
+    hurlfmt tests/api-collection/**/*.hurl --in-place
 
 # Check is the codebase properly formatted.
 fmt-check:
     cargo fmt --all -- --check
     dprint check
+    hurlfmt tests/api-collection/**/*.hurl --check
 
 # Lint the codebase.
 lint:

tests/api-collection/meta/health.hurl

@@ -0,0 +1,17 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  health {
+    status
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.health.status" == "running"
+
+

tests/api-collection/meta/meta.hurl

@@ -0,0 +1,21 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  meta {
+    build
+    version
+    config {
+      env
+      baseUrl
+      port
+    }
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.meta.build" == "unknown"

tests/api-collection/props/local

@@ -0,0 +1 @@
+base_url=http://127.0.0.1:8001/graphql

tests/api-collection/props/prod

@@ -0,0 +1,2 @@
+base_url=http://1.0.0.2:8001/graphql
+

tests/api-collection/props/staging

@@ -0,0 +1,2 @@
+base_url=http://1.0.0.1:8001/graphql
+

tests/api-collection/user/create_user.hurl

@@ -0,0 +1,20 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+mutation {
+  createUser(input: { name: "aragorn", email: "[email protected]" }) {
+    id
+    name
+    email
+    fullName
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.createUser.name" == "aragorn"
+
+

tests/api-collection/user/create_user_without_email.hurl

@@ -0,0 +1,20 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+mutation {
+  createUser(input: { name: "aragorn" }) {
+    id
+    name
+    email
+    fullName
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.createUser.name" == "aragorn"
+
+

tests/api-collection/user/delete_user.hurl

@@ -0,0 +1,19 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+mutation {
+  deleteUser(id: "017eb8d1-a5b5-9443-2d94-b6ad7787bf0e") {
+    id
+    name
+    fullName
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.deleteUser.name" == "frodo"
+
+

tests/api-collection/user/update_user.hurl

@@ -0,0 +1,22 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+mutation {
+  updateUser(
+    input: { id: "017eba0e-ca9a-f014-fc85-1cf8a22a8999", name: "frodo" }
+  ) {
+    id
+    name
+    fullName
+  }
+}
+
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.updateUser.name" == "frodo"
+
+

tests/api-collection/user/user.hurl

@@ -0,0 +1,19 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  user(id: "017eb8d1-a5b5-9443-2d94-b6ad7787bf0e") {
+    id
+    name
+    email
+    fullName
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+
+

tests/api-collection/user/users.hurl

@@ -0,0 +1,21 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  users(first: 7) {
+    edges {
+      node {
+        name
+      }
+    }
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+jsonpath "$.data.users.edges" isEmpty
+
+

tests/api-collection/user/users_both_first_and_last.hurl

@@ -0,0 +1,21 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  users(first: 3, last: 3) {
+    edges {
+      cursor
+      node {
+        id
+        name
+      }
+    }
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+jsonpath "$.errors[0].message" contains "Passing both `first` and `last` for pagination is not supported"
+

tests/api-collection/user/users_first_3.hurl

@@ -0,0 +1,29 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  users(first: 3) {
+    edges {
+      cursor
+      node {
+        id
+        name
+      }
+    }
+    pageInfo {
+      hasNextPage
+      hasPreviousPage
+      startCursor
+      endCursor
+    }
+    totalCount
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+
+

tests/api-collection/user/users_first_3_after_n.hurl

@@ -0,0 +1,31 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  users(
+    first: 2
+    after: "Q3Vyc29yOjAxN2YyYTlmLWVjNmMtYzk1ZS01MGVhLWUzZWZkMWIxMjZhNw"
+  ) {
+    edges {
+      cursor
+      node {
+        id
+        name
+      }
+    }
+    pageInfo {
+      hasNextPage
+      hasPreviousPage
+      startCursor
+      endCursor
+    }
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+
+

tests/api-collection/user/users_invalid_cursor.hurl

@@ -0,0 +1,30 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  users(
+    first: 2
+    after: "randomZkMWIxMjZhw"
+  ) {
+    edges {
+      cursor
+      node {
+        id
+        name
+      }
+    }
+    pageInfo {
+      hasNextPage
+      hasPreviousPage
+      startCursor
+      endCursor
+    }
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+jsonpath "$.errors[0].message" contains "Invalid cursor"
+

tests/api-collection/user/users_last_1_before_n.hurl

@@ -0,0 +1,31 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+query {
+  users(
+    last: 3
+    before: "Q3Vyc29yOjAxN2YyYTlmLWVjNmMtYzk1ZS01MGVhLWUzZWZkMWIxMjZhNw"
+  ) {
+    edges {
+      cursor
+      node {
+        id
+        name
+      }
+    }
+    pageInfo {
+      hasNextPage
+      hasPreviousPage
+      startCursor
+      endCursor
+    }
+  }
+}
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+
+

tests/api-collection/user/users_last_3.hurl

@@ -0,0 +1,30 @@
+POST {{base_url}}
+Content-Type: application/json
+
+```graphql
+{
+  users(last: 3) {
+    edges {
+      cursor
+      node {
+        id
+        name
+      }
+    }
+    pageInfo {
+      hasNextPage
+      hasPreviousPage
+      startCursor
+      endCursor
+    }
+    totalCount
+  }
+}
+
+```
+
+HTTP/1.1 200
+[Asserts]
+status == 200
+
+