Nikos/5430/validator unit test coverage (#5525)

* Add codePoint tests * Add hexToNumber tests * Add default validator test * Add invalid bloom test * Add error tests * Add index tests * Add more tests * Remove comments
web3 · Oct 21, 2022 · bfce27f · bfce27f
1 parent 301c3a1
commit bfce27f
Show file tree

Hide file tree

Showing 9 changed files with 532 additions and 14 deletions.
diff --git a/packages/web3-validator/test/fixtures/abi_to_json_schema.ts b/packages/web3-validator/test/fixtures/abi_to_json_schema.ts
@@ -17,7 +17,7 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 
 import { FullValidationSchema, JsonSchema, ShortValidationSchema } from '../../src/types';
 
-export const abiToJsonSchemaCases: {
+export type AbiToJsonSchemaCase = {
 	title: string;
 	abi: {
 		fullSchema: FullValidationSchema;
@@ -29,9 +29,10 @@ export const abiToJsonSchemaCases: {
 		shortSchema: JsonSchema;
 		data: Record<string, unknown> | Array<unknown>;
 	};
-}[] = [
+};
+export const abiToJsonSchemaCases: AbiToJsonSchemaCase[] = [
 	{
-		title: 'single param',
+		title: 'single param uint',
 		abi: {
 			fullSchema: [{ name: 'a', type: 'uint' }],
 			shortSchema: ['uint'],
@@ -53,6 +54,75 @@ export const abiToJsonSchemaCases: {
 			data: [12],
 		},
 	},
+	{
+		title: 'single param address',
+		abi: {
+			fullSchema: [{ name: 'a', type: 'address' }],
+			shortSchema: ['address'],
+			data: ['0xCB00CDE33a7a0Fba30C63745534F1f7Ae607076b'],
+		},
+		json: {
+			fullSchema: {
+				type: 'array',
+				items: [{ $id: 'a', eth: 'address' }],
+				minItems: 1,
+				maxItems: 1,
+			},
+			shortSchema: {
+				type: 'array',
+				items: [{ $id: '/0/0', eth: 'address' }],
+				minItems: 1,
+				maxItems: 1,
+			},
+			data: ['0xCB00CDE33a7a0Fba30C63745534F1f7Ae607076b'],
+		},
+	},
+	{
+		title: 'single param bool',
+		abi: {
+			fullSchema: [{ name: 'a', type: 'bool' }],
+			shortSchema: ['bool'],
+			data: [true],
+		},
+		json: {
+			fullSchema: {
+				type: 'array',
+				items: [{ $id: 'a', eth: 'bool' }],
+				minItems: 1,
+				maxItems: 1,
+			},
+			shortSchema: {
+				type: 'array',
+				items: [{ $id: '/0/0', eth: 'bool' }],
+				minItems: 1,
+				maxItems: 1,
+			},
+			data: [true],
+		},
+	},
+	{
+		title: 'single param bytes',
+		abi: {
+			fullSchema: [{ name: 'a', type: 'bytes' }],
+			shortSchema: ['bytes'],
+			data: ['0xCB00CDE33a7a0Fba30C63745534F1f7Ae607076b'],
+		},
+		json: {
+			fullSchema: {
+				type: 'array',
+				items: [{ $id: 'a', eth: 'bytes' }],
+				minItems: 1,
+				maxItems: 1,
+			},
+			shortSchema: {
+				type: 'array',
+				items: [{ $id: '/0/0', eth: 'bytes' }],
+				minItems: 1,
+				maxItems: 1,
+			},
+			data: ['0xCB00CDE33a7a0Fba30C63745534F1f7Ae607076b'],
+		},
+	},
 
 	{
 		title: 'multiple params',

diff --git a/packages/web3-validator/test/fixtures/errors.ts b/packages/web3-validator/test/fixtures/errors.ts
@@ -0,0 +1,69 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+export const fullErrors: any[] = [
+	{
+		instancePath: '',
+		schemaPath: '#/minItems',
+		keyword: 'minItems',
+		params: { limit: 1 },
+		message: 'must NOT have fewer than 1 items',
+	},
+	{
+		instancePath: '',
+		schemaPath: '#/minItems',
+		keyword: 'minItems',
+		params: { limit: 2 },
+		message: 'must NOT have fewer than 2 items',
+	},
+	{
+		instancePath: '',
+		schemaPath: '#/maxItems',
+		keyword: 'maxItems',
+		params: { limit: 1 },
+		message: 'must NOT have more than 1 items',
+	},
+];
+
+export const fullErrorsWithInstance: any[] = [
+	{
+		message: 'must pass "uint" validation',
+		keyword: 'eth',
+		params: { value: -1 },
+		instancePath: '/0',
+		schemaPath: '#/items/0/eth',
+	},
+];
+
+export const errorsWithInstanceNoParams: any[] = [
+	{
+		message: 'must pass "uint" validation',
+		keyword: 'eth',
+		instancePath: '/0',
+		schemaPath: '#/items/0/eth',
+	},
+];
+
+export const errorsWithInstanceNoParamsNoMessage: any[] = [
+	{
+		keyword: 'eth',
+		instancePath: '/0',
+		schemaPath: '#/items/0/eth',
+	},
+];
+
+export const unspecifiedErrors: any[] = [{}];
diff --git a/packages/web3-validator/test/fixtures/validation.ts b/packages/web3-validator/test/fixtures/validation.ts
@@ -16,6 +16,7 @@ along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
 */
 
 import { Filter } from 'web3-types';
+import { ValidInputTypes } from '../../src/types';
 
 export const validUintData: any[] = [
 	'0x48',
@@ -109,16 +110,28 @@ export const invalidIntDataWithAbiType: [any, string][] = [
 	['-0x0dec0518fa672a70027b04c286582e543ab17319fbdd384fa7bc8f3d5a542c0b', 'uint8'],
 ];
 
+export const validHexStrictDataWithNumber: [string, number | bigint][] = [
+	['0x48', 72],
+	['0x123c', 4668],
+	[
+		'0xdec0518fa672a70027b04c286582e543ab17319fbdd384fa7bc8f3d5a542c0b',
+		BigInt('6297078121011128569053558207054331251192909352593326480842737114300118477835'),
+	],
+	[
+		'0xd115bffabbdd893a6f7cea402e7338643ced44a6',
+		BigInt('1193664110518272216229793131906554422260021413030'),
+	],
+	[
+		'0x2C941171bD2A7aEda7c2767c438DfF36EAaFdaFc',
+		BigInt('254497623817844434235817792799421766503337286396'),
+	],
+	['0x1', 1],
+	['0xcd', 205],
+	['-0xcd', -205],
+];
 export const validHexStrictData: any[] = [
-	'0x48',
-	'0x123c',
-	'0x0dec0518fa672a70027b04c286582e543ab17319fbdd384fa7bc8f3d5a542c0b',
-	'0xd115bffabbdd893a6f7cea402e7338643ced44a6',
-	'0x2C941171bD2A7aEda7c2767c438DfF36EAaFdaFc',
-	'0x1',
-	'0xcd',
-	'-0xcd',
-	'-0x0dec0518fa672a70027b04c286582e543ab17319fbdd384fa7bc8f3d5a542c0b',
+	...validHexStrictDataWithNumber.map(tuple => tuple[0]),
+	'-0xdec0518fa672a70027b04c286582e543ab17319fbdd384fa7bc8f3d5a542c0b',
 ];
 
 export const invalidHexData: any[] = [
@@ -158,6 +171,31 @@ export const validHexData: any[] = [
 	BigInt(-255),
 ];
 
+export const validStringNumbersWithHex: [string, string][] = [
+	['72', '0x48'],
+	['4668', '0x123c'],
+	[
+		'6297078121011128569053558207054331251192909352593326480842737114300118477835',
+		'0xdec0518fa672a70027b04c286582e543ab17319fbdd384fa7bc8f3d5a542c0b',
+	],
+	[
+		'1193664110518272216229793131906554422260021413030',
+		'0xd115bffabbdd893a6f7cea402e7338643ced44a6',
+	],
+	[
+		'254497623817844434235817792799421766503337286396',
+		'0x2C941171bD2A7aEda7c2767c438DfF36EAaFdaFc',
+	],
+	['1', '0x1'],
+	['205', '0xcd'],
+	['-205', '-0xcd'],
+];
+
+export const invalidStringNumbers: ValidInputTypes[] = [
+	new ArrayBuffer(23255),
+	Buffer.from('abce', 'hex'),
+	Buffer.from('hello', 'utf8'),
+];
 export const validCheckAddressCheckSumData: any[] = [
 	'0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d',
 	'0x52908400098527886E0F7030069857D2E4169EE7',
@@ -261,6 +299,12 @@ export const invalidInBloomData: any[] = [
 		'0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
 		'0xhello',
 	],
+	[0, '0x6254B927ecC25DDd233aAECD5296D746B1C006B4'],
+	[
+		// mix a and A
+		'0xaA000000200000000010000080000000000002000000000000000000000000000000000000020200000000000000000000800001000000000000000000200000000000000000000000000008000000800000000000000000000000000000000000000000020000000000000000000800000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000080000000000000000000000100000000000000000000000002000000000001000080000000000000000000000000000000000020200010000000000000000000000000000000000000100000000000000000000000',
+		'0x98afe7a8d28bbc88dcf41f8e06d97c74958a47dc',
+	],
 ];
 
 export const validUserEthereumAddressInBloomData: any[] = [
@@ -279,6 +323,11 @@ export const invalidUserEthereumAddressInBloomData: any[] = [
 		'0x00000000000000000000000000000000000000000000000000008000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000008000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000002000000000000000000000000000000100000000000000082000000000080000000000000000000000000000000000000000000000002000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
 		'0xH1',
 	],
+	[
+		// mix a and A
+		'0xaA000000200000000010000080000000000002000000000000000000000000000000000000020200000000000000000000800001000000000000000000200000000000000000000000000008000000800000000000000000000000000000000000000000020000000000000000000800000000000000000000000010000000000000000000000000000000000000000000000000000000000000000000000000020000000000000000000080000000000000000000000100000000000000000000000002000000000001000080000000000000000000000000000000000020200010000000000000000000000000000000000000100000000000000000000000',
+		'0x98afe7a8d28bbc88dcf41f8e06d97c74958a47dc',
+	],
 ];
 
 export const validTopicData: any[] = [
@@ -545,3 +594,50 @@ export const invalidEthTypeData: string[] = [
 	'my-addresss',
 	'boolean',
 ];
+
+export const validCodePoints: [number, number][] = [
+	[48, 0],
+	[51, 3],
+	[55, 7],
+	[57, 9],
+	[65, 10],
+	[70, 15],
+	[97, 10],
+	[100, 13],
+	[102, 15],
+];
+
+export const invalidCodePoints: number[] = [-100, -5, 0, 30, 58, 75, 90, 103, 200];
+
+export const padLeftData: { padDigits: number; data: [ValidInputTypes, string][] } = {
+	padDigits: 64,
+	data: [
+		[
+			'dfd5293d8e347dfe59e90efd55b2956a1343963d',
+			'000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d',
+		],
+		[
+			'-0xdfd5293d8e347dfe59e90efd55b2956a1343963d',
+			'-0x000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d',
+		],
+		[2, '0x0000000000000000000000000000000000000000000000000000000000000002'],
+	],
+};
+
+export const validNotBaseTypeData: { dataType: string; data: any }[] = [
+	{ dataType: 'hex', data: '0x000000000000000000000000dfd5293d8e347dfe59e90efd55b2956a1343963d' },
+	{ dataType: 'number', data: 42 },
+	{ dataType: 'blockNumber', data: 42 },
+	{ dataType: 'blockNumberOrTag', data: 'latest' },
+	{
+		dataType: 'filter',
+		data: {
+			fromBlock: 'latest',
+			toBlock: 'latest',
+		},
+	},
+	{
+		dataType: 'bloom',
+		data: '0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000',
+	},
+];
diff --git a/packages/web3-validator/test/unit/default_validator.test.ts b/packages/web3-validator/test/unit/default_validator.test.ts
@@ -0,0 +1,26 @@
+/*
+This file is part of web3.js.
+
+web3.js is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+web3.js is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with web3.js.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+import { validator } from '../../src/default_validator';
+import { Web3Validator } from '../../src/web3_validator';
+
+describe('default web3-validator', () => {
+	it('should be instance', () => {
+		expect(validator).toBeDefined();
+		expect(validator).toBeInstanceOf(Web3Validator);
+	});
+});