Increase newman postman tests coverage (#393)

Nana-EC · web-flow · commit 4d5c2018d6a7 · 2022-07-29T19:57:44.000-05:00
Postman newman tests can be used to make multipl quick rpc calls to an endpoint.
The current solution is missing a few consensus node hitting calls

- Add `eth_gasPrice`
- Add `eth_feeHistory`
- Update `postman.json` to use `baseUrl`
- Add github action to run newman script

Signed-off-by: Nana-EC &lt;nana@swirldslabs.com&gt;
diff --git a/.github/workflows/postman.yml b/.github/workflows/postman.yml
@@ -0,0 +1,52 @@
+name: Postman Endpoint Tests
+
+on:
+  pull_request:
+    branches: [ main, release/** ]
+  push:
+    branches: [ main, release/** ]
+    tags: [ v* ]
+
+jobs:
+  setup-local-hedera:
+    name: Postman Endpoint Tests
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Setup node
+        uses: actions/setup-node@v2
+        with:
+          node-version: 16
+
+      - name: Checkout repo
+        uses: actions/checkout@v2
+
+      - name: Install packages
+        run: npm ci
+
+      - name: Create .env file
+        run: cp ./packages/server/tests/localAcceptance.env .env
+
+      - name: Lerna Bootstrap
+        run: npm run setup
+
+      - name: Install pnpm
+        run: npm install -g pnpm
+
+      - name: Build Typescript
+        run: npx lerna run build
+
+      - name: Run RPC Server
+        run: npm run integration:prerequisite &
+
+      - name: Install newman
+        run: npm install -g newman
+
+      - name: Run the newman script        
+        uses: nick-fields/retry@v2
+        with:
+          max_attempts: 10
+          timeout_minutes: 10
+          retry_wait_seconds: 45
+          command: newman run packages/server/tests/postman.json
diff --git a/packages/server/tests/postman.json b/packages/server/tests/postman.json
@@ -39,9 +39,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -79,9 +79,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -119,9 +119,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -159,9 +159,95 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "eth_feeHistory",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"Success\", () => {",
+							"    var response = pm.response.json();",
+							"    pm.expect(response.result.baseFeePerGas).to.be.an(\"array\");",
+							"    pm.expect(response.result.baseFeePerGas).length(4);",
+							"    pm.expect(response.result.gasUsedRatio).to.be.an(\"array\");",
+							"    pm.expect(response.result.gasUsedRatio).length(3);",
+							"    pm.expect(response.result.oldestBlock).to.match(/^0x[a-f0-9]+$/);",
+							"    pm.expect(response.result.reward).to.be.an(\"array\");",
+							"    pm.expect(response.result.reward).length(3);",
+							"    pm.expect(response.id).to.equal(\"test_id\");",
+							"    pm.expect(response.jsonrpc).to.equal(\"2.0\");",
+							"});",
+							""
+						],
+						"type": "text/javascript"
+					}
+				}
+			],
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n    \"id\": \"test_id\",\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"eth_feeHistory\",\n    \"params\": [3, \"latest\", [25, 75]]\n}",
+					"options": {
+						"raw": {
+							"language": "json"
+						}
+					}
+				},
+				"url": {
+					"raw": "{{baseUrl}}",
+					"host": [
+						"{{baseUrl}}"
+					]
+				}
+			},
+			"response": []
+		},
+		{
+			"name": "eth_gasPrice",
+			"event": [
+				{
+					"listen": "test",
+					"script": {
+						"exec": [
+							"pm.test(\"Success\", () => {",
+							"    var response = pm.response.json();",
+							"    pm.expect(response.result).to.match(/^0x[a-f0-9]+$/);",
+							"    pm.expect(response.id).to.equal(\"test_id\");",
+							"    pm.expect(response.jsonrpc).to.equal(\"2.0\");",
+							"});",
+							""
+						],
+						"type": "text/javascript"
+					}
+				}
+			],
+			"request": {
+				"method": "POST",
+				"header": [],
+				"body": {
+					"mode": "raw",
+					"raw": "{\n    \"id\": \"test_id\",\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"eth_gasPrice\",\n    \"params\": []\n}",
+					"options": {
+						"raw": {
+							"language": "json"
+						}
+					}
+				},
+				"url": {
+					"raw": "{{baseUrl}}",
+					"host": [
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -199,9 +285,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -259,9 +345,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -299,9 +385,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -339,9 +425,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -379,9 +465,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -419,9 +505,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -459,9 +545,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -501,9 +587,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -542,9 +628,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -583,9 +669,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -623,9 +709,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -663,9 +749,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -703,9 +789,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -743,9 +829,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -783,9 +869,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -823,9 +909,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -863,9 +949,9 @@
 					}
 				},
 				"url": {
-					"raw": "{{base_url}}",
+					"raw": "{{baseUrl}}",
 					"host": [
-						"{{base_url}}"
+						"{{baseUrl}}"
 					]
 				}
 			},
@@ -894,7 +980,7 @@
 	],
 	"variable": [
 		{
-			"key": "base_url",
+			"key": "baseUrl",
 			"value": "localhost:7546",
 			"type": "string"
 		}

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,9 @@`
`39`	`39`	`}`
`40`	`40`	`},`
`41`	`41`	`"url": {`
`42`		`- "raw": "{{base_url}}",`
	`42`	`+ "raw": "{{baseUrl}}",`
`43`	`43`	`"host": [`
`44`		`- "{{base_url}}"`
	`44`	`+ "{{baseUrl}}"`
`45`	`45`	`]`
`46`	`46`	`}`
`47`	`47`	`},`
`@@ -79,9 +79,9 @@`
`79`	`79`	`}`
`80`	`80`	`},`
`81`	`81`	`"url": {`
`82`		`- "raw": "{{base_url}}",`
	`82`	`+ "raw": "{{baseUrl}}",`
`83`	`83`	`"host": [`
`84`		`- "{{base_url}}"`
	`84`	`+ "{{baseUrl}}"`
`85`	`85`	`]`
`86`	`86`	`}`
`87`	`87`	`},`
`@@ -119,9 +119,9 @@`
`119`	`119`	`}`
`120`	`120`	`},`
`121`	`121`	`"url": {`
`122`		`- "raw": "{{base_url}}",`
	`122`	`+ "raw": "{{baseUrl}}",`
`123`	`123`	`"host": [`
`124`		`- "{{base_url}}"`
	`124`	`+ "{{baseUrl}}"`
`125`	`125`	`]`
`126`	`126`	`}`
`127`	`127`	`},`
`@@ -159,9 +159,95 @@`
`159`	`159`	`}`
`160`	`160`	`},`
`161`	`161`	`"url": {`
`162`		`- "raw": "{{base_url}}",`
	`162`	`+ "raw": "{{baseUrl}}",`
`163`	`163`	`"host": [`
`164`		`- "{{base_url}}"`
	`164`	`+ "{{baseUrl}}"`
	`165`	`+ ]`
	`166`	`+ }`
	`167`	`+ },`
	`168`	`+ "response": []`
	`169`	`+ },`
	`170`	`+ {`
	`171`	`+ "name": "eth_feeHistory",`
	`172`	`+ "event": [`
	`173`	`+ {`
	`174`	`+ "listen": "test",`
	`175`	`+ "script": {`
	`176`	`+ "exec": [`
	`177`	`+ "pm.test(\"Success\", () => {",`
	`178`	`+ " var response = pm.response.json();",`
	`179`	`+ " pm.expect(response.result.baseFeePerGas).to.be.an(\"array\");",`
	`180`	`+ " pm.expect(response.result.baseFeePerGas).length(4);",`
	`181`	`+ " pm.expect(response.result.gasUsedRatio).to.be.an(\"array\");",`
	`182`	`+ " pm.expect(response.result.gasUsedRatio).length(3);",`
	`183`	`+ " pm.expect(response.result.oldestBlock).to.match(/^0x[a-f0-9]+$/);",`
	`184`	`+ " pm.expect(response.result.reward).to.be.an(\"array\");",`
	`185`	`+ " pm.expect(response.result.reward).length(3);",`
	`186`	`+ " pm.expect(response.id).to.equal(\"test_id\");",`
	`187`	`+ " pm.expect(response.jsonrpc).to.equal(\"2.0\");",`
	`188`	`+ "});",`
	`189`	`+ ""`
	`190`	`+ ],`
	`191`	`+ "type": "text/javascript"`
	`192`	`+ }`
	`193`	`+ }`
	`194`	`+ ],`
	`195`	`+ "request": {`
	`196`	`+ "method": "POST",`
	`197`	`+ "header": [],`
	`198`	`+ "body": {`
	`199`	`+ "mode": "raw",`
	`200`	`+ "raw": "{\n \"id\": \"test_id\",\n \"jsonrpc\": \"2.0\",\n \"method\": \"eth_feeHistory\",\n \"params\": [3, \"latest\", [25, 75]]\n}",`
	`201`	`+ "options": {`
	`202`	`+ "raw": {`
	`203`	`+ "language": "json"`
	`204`	`+ }`
	`205`	`+ }`
	`206`	`+ },`
	`207`	`+ "url": {`
	`208`	`+ "raw": "{{baseUrl}}",`
	`209`	`+ "host": [`
	`210`	`+ "{{baseUrl}}"`
	`211`	`+ ]`
	`212`	`+ }`
	`213`	`+ },`
	`214`	`+ "response": []`
	`215`	`+ },`
	`216`	`+ {`
	`217`	`+ "name": "eth_gasPrice",`
	`218`	`+ "event": [`
	`219`	`+ {`
	`220`	`+ "listen": "test",`
	`221`	`+ "script": {`
	`222`	`+ "exec": [`
	`223`	`+ "pm.test(\"Success\", () => {",`
	`224`	`+ " var response = pm.response.json();",`
	`225`	`+ " pm.expect(response.result).to.match(/^0x[a-f0-9]+$/);",`
	`226`	`+ " pm.expect(response.id).to.equal(\"test_id\");",`
	`227`	`+ " pm.expect(response.jsonrpc).to.equal(\"2.0\");",`
	`228`	`+ "});",`
	`229`	`+ ""`
	`230`	`+ ],`
	`231`	`+ "type": "text/javascript"`
	`232`	`+ }`
	`233`	`+ }`
	`234`	`+ ],`
	`235`	`+ "request": {`
	`236`	`+ "method": "POST",`
	`237`	`+ "header": [],`
	`238`	`+ "body": {`
	`239`	`+ "mode": "raw",`
	`240`	`+ "raw": "{\n \"id\": \"test_id\",\n \"jsonrpc\": \"2.0\",\n \"method\": \"eth_gasPrice\",\n \"params\": []\n}",`
	`241`	`+ "options": {`
	`242`	`+ "raw": {`
	`243`	`+ "language": "json"`
	`244`	`+ }`
	`245`	`+ }`
	`246`	`+ },`
	`247`	`+ "url": {`
	`248`	`+ "raw": "{{baseUrl}}",`
	`249`	`+ "host": [`
	`250`	`+ "{{baseUrl}}"`
`165`	`251`	`]`
`166`	`252`	`}`
`167`	`253`	`},`
`@@ -199,9 +285,9 @@`
`199`	`285`	`}`
`200`	`286`	`},`
`201`	`287`	`"url": {`
`202`		`- "raw": "{{base_url}}",`
	`288`	`+ "raw": "{{baseUrl}}",`
`203`	`289`	`"host": [`
`204`		`- "{{base_url}}"`
	`290`	`+ "{{baseUrl}}"`
`205`	`291`	`]`
`206`	`292`	`}`
`207`	`293`	`},`
`@@ -259,9 +345,9 @@`
`259`	`345`	`}`
`260`	`346`	`},`
`261`	`347`	`"url": {`
`262`		`- "raw": "{{base_url}}",`
	`348`	`+ "raw": "{{baseUrl}}",`
`263`	`349`	`"host": [`
`264`		`- "{{base_url}}"`
	`350`	`+ "{{baseUrl}}"`
`265`	`351`	`]`
`266`	`352`	`}`
`267`	`353`	`},`
`@@ -299,9 +385,9 @@`
`299`	`385`	`}`
`300`	`386`	`},`
`301`	`387`	`"url": {`
`302`		`- "raw": "{{base_url}}",`
	`388`	`+ "raw": "{{baseUrl}}",`
`303`	`389`	`"host": [`
`304`		`- "{{base_url}}"`
	`390`	`+ "{{baseUrl}}"`
`305`	`391`	`]`
`306`	`392`	`}`
`307`	`393`	`},`
`@@ -339,9 +425,9 @@`
`339`	`425`	`}`
`340`	`426`	`},`
`341`	`427`	`"url": {`
`342`		`- "raw": "{{base_url}}",`
	`428`	`+ "raw": "{{baseUrl}}",`
`343`	`429`	`"host": [`
`344`		`- "{{base_url}}"`
	`430`	`+ "{{baseUrl}}"`
`345`	`431`	`]`
`346`	`432`	`}`
`347`	`433`	`},`
`@@ -379,9 +465,9 @@`
`379`	`465`	`}`
`380`	`466`	`},`
`381`	`467`	`"url": {`
`382`		`- "raw": "{{base_url}}",`
	`468`	`+ "raw": "{{baseUrl}}",`
`383`	`469`	`"host": [`
`384`		`- "{{base_url}}"`
	`470`	`+ "{{baseUrl}}"`
`385`	`471`	`]`
`386`	`472`	`}`
`387`	`473`	`},`
`@@ -419,9 +505,9 @@`
`419`	`505`	`}`
`420`	`506`	`},`
`421`	`507`	`"url": {`
`422`		`- "raw": "{{base_url}}",`
	`508`	`+ "raw": "{{baseUrl}}",`
`423`	`509`	`"host": [`
`424`		`- "{{base_url}}"`
	`510`	`+ "{{baseUrl}}"`
`425`	`511`	`]`
`426`	`512`	`}`
`427`	`513`	`},`
`@@ -459,9 +545,9 @@`
`459`	`545`	`}`
`460`	`546`	`},`
`461`	`547`	`"url": {`
`462`		`- "raw": "{{base_url}}",`
	`548`	`+ "raw": "{{baseUrl}}",`
`463`	`549`	`"host": [`
`464`		`- "{{base_url}}"`
	`550`	`+ "{{baseUrl}}"`
`465`	`551`	`]`
`466`	`552`	`}`
`467`	`553`	`},`
`@@ -501,9 +587,9 @@`
`501`	`587`	`}`
`502`	`588`	`},`
`503`	`589`	`"url": {`
`504`		`- "raw": "{{base_url}}",`
	`590`	`+ "raw": "{{baseUrl}}",`
`505`	`591`	`"host": [`
`506`		`- "{{base_url}}"`
	`592`	`+ "{{baseUrl}}"`
`507`	`593`	`]`
`508`	`594`	`}`
`509`	`595`	`},`
`@@ -542,9 +628,9 @@`
`542`	`628`	`}`
`543`	`629`	`},`
`544`	`630`	`"url": {`
`545`		`- "raw": "{{base_url}}",`
	`631`	`+ "raw": "{{baseUrl}}",`
`546`	`632`	`"host": [`
`547`		`- "{{base_url}}"`
	`633`	`+ "{{baseUrl}}"`
`548`	`634`	`]`
`549`	`635`	`}`
`550`	`636`	`},`
`@@ -583,9 +669,9 @@`
`583`	`669`	`}`
`584`	`670`	`},`
`585`	`671`	`"url": {`
`586`		`- "raw": "{{base_url}}",`
	`672`	`+ "raw": "{{baseUrl}}",`
`587`	`673`	`"host": [`
`588`		`- "{{base_url}}"`
	`674`	`+ "{{baseUrl}}"`
`589`	`675`	`]`
`590`	`676`	`}`
`591`	`677`	`},`
`@@ -623,9 +709,9 @@`
`623`	`709`	`}`
`624`	`710`	`},`
`625`	`711`	`"url": {`
`626`		`- "raw": "{{base_url}}",`
	`712`	`+ "raw": "{{baseUrl}}",`
`627`	`713`	`"host": [`
`628`		`- "{{base_url}}"`
	`714`	`+ "{{baseUrl}}"`
`629`	`715`	`]`
`630`	`716`	`}`
`631`	`717`	`},`
`@@ -663,9 +749,9 @@`
`663`	`749`	`}`
`664`	`750`	`},`
`665`	`751`	`"url": {`
`666`		`- "raw": "{{base_url}}",`
	`752`	`+ "raw": "{{baseUrl}}",`
`667`	`753`	`"host": [`
`668`		`- "{{base_url}}"`
	`754`	`+ "{{baseUrl}}"`
`669`	`755`	`]`
`670`	`756`	`}`
`671`	`757`	`},`
`@@ -703,9 +789,9 @@`
`703`	`789`	`}`
`704`	`790`	`},`
`705`	`791`	`"url": {`
`706`		`- "raw": "{{base_url}}",`
	`792`	`+ "raw": "{{baseUrl}}",`
`707`	`793`	`"host": [`
`708`		`- "{{base_url}}"`
	`794`	`+ "{{baseUrl}}"`
`709`	`795`	`]`
`710`	`796`	`}`
`711`	`797`	`},`
`@@ -743,9 +829,9 @@`
`743`	`829`	`}`
`744`	`830`	`},`
`745`	`831`	`"url": {`
`746`		`- "raw": "{{base_url}}",`
	`832`	`+ "raw": "{{baseUrl}}",`
`747`	`833`	`"host": [`
`748`		`- "{{base_url}}"`
	`834`	`+ "{{baseUrl}}"`
`749`	`835`	`]`
`750`	`836`	`}`
`751`	`837`	`},`
`@@ -783,9 +869,9 @@`
`783`	`869`	`}`
`784`	`870`	`},`
`785`	`871`	`"url": {`
`786`		`- "raw": "{{base_url}}",`
	`872`	`+ "raw": "{{baseUrl}}",`
`787`	`873`	`"host": [`
`788`		`- "{{base_url}}"`
	`874`	`+ "{{baseUrl}}"`
`789`	`875`	`]`
`790`	`876`	`}`
`791`	`877`	`},`
`@@ -823,9 +909,9 @@`
`823`	`909`	`}`
`824`	`910`	`},`
`825`	`911`	`"url": {`
`826`		`- "raw": "{{base_url}}",`
	`912`	`+ "raw": "{{baseUrl}}",`
`827`	`913`	`"host": [`
`828`		`- "{{base_url}}"`
	`914`	`+ "{{baseUrl}}"`
`829`	`915`	`]`
`830`	`916`	`}`
`831`	`917`	`},`
`@@ -863,9 +949,9 @@`
`863`	`949`	`}`
`864`	`950`	`},`
`865`	`951`	`"url": {`
`866`		`- "raw": "{{base_url}}",`
	`952`	`+ "raw": "{{baseUrl}}",`
`867`	`953`	`"host": [`
`868`		`- "{{base_url}}"`
	`954`	`+ "{{baseUrl}}"`
`869`	`955`	`]`
`870`	`956`	`}`
`871`	`957`	`},`
`@@ -894,7 +980,7 @@`
`894`	`980`	`],`
`895`	`981`	`"variable": [`
`896`	`982`	`{`
`897`		`- "key": "base_url",`
	`983`	`+ "key": "baseUrl",`
`898`	`984`	`"value": "localhost:7546",`
`899`	`985`	`"type": "string"`
`900`	`986`	`}`