Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: added error code expectations to the exhaustive examples #3135

Merged
merged 4 commits into from
Sep 9, 2024
Merged

chore: added error code expectations to the exhaustive examples #3135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8125fff
chore: added error code expectations
petertonysmith94 Sep 9, 2024
105a788
chore: use error
petertonysmith94 Sep 9, 2024
66d81af
chore: added changeset
petertonysmith94 Sep 9, 2024
74db961
chore: changeset
petertonysmith94 Sep 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .changeset/ninety-geese-report.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
---

chore: added error code expectations to the exhaustive examples
43 changes: 39 additions & 4 deletions packages/abi-coder/test/Interface.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/* eslint-disable @typescript-eslint/no-explicit-any */
import { FuelError } from '@fuel-ts/errors';
import { expectToThrowFuelError } from '@fuel-ts/errors/test-utils';
import type { BN } from '@fuel-ts/math';
import { concat } from '@fuel-ts/utils';

Expand Down Expand Up @@ -636,121 +638,154 @@ describe('Abi interface', () => {
fn: exhaustiveExamplesInterface.functions.u_8,
title: '[u8] - negative',
value: -1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u8.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_8,
title: '[u8] - over max',
value: U8_MAX + 1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u8, too many bytes.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_16,
title: '[u16] - negative',
value: -1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u16.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_16,
title: '[u16] - over max',
value: U32_MAX + 1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u16, too many bytes.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_32,
title: '[u32] - negative',
value: -1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u32.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_32,
title: '[u32] - over max',
value: U32_MAX + 1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u32, too many bytes.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_64,
title: '[u64] - negative',
value: -1,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u64.'),
},
{
fn: exhaustiveExamplesInterface.functions.u_64,
title: '[u64] - over max',
value: U64_MAX.add(1),
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid u64.'),
},
{
fn: exhaustiveExamplesInterface.functions.b_256,
title: '[b256] - too short',
value: B256_DECODED.slice(0, B256_DECODED.length - 1),
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid b256.'),
},
{
fn: exhaustiveExamplesInterface.functions.b_256,
title: '[b256] - too long',
value: `${B256_DECODED}0`,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid b256.'),
},
{
fn: exhaustiveExamplesInterface.functions.b_256,
title: '[b256] - not hex',
value: `not a hex string`,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid b256.'),
},
{
fn: exhaustiveExamplesInterface.functions.b_512,
title: '[b512] - too short',
value: B512_ENCODED.slice(0, B512_ENCODED.length - 1),
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid struct B512.'),
},
{
fn: exhaustiveExamplesInterface.functions.b_512,
title: '[b512] - too long',
value: `${B512_DECODED}0`,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid struct B512.'),
},
{
fn: exhaustiveExamplesInterface.functions.b_256,
title: '[b512] - not hex',
value: `not a hex string`,
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid b256.'),
},
{
fn: exhaustiveExamplesInterface.functions.boolean,
title: '[boolean] - not bool',
value: 'not bool',
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Invalid boolean value.'),
},
{
fn: exhaustiveExamplesInterface.functions.enum_simple,
title: '[enum] - not in values',
value: "Doesn't exist",
error: new FuelError(
FuelError.CODES.INVALID_DECODE_VALUE,
petertonysmith94 marked this conversation as resolved.
Show resolved Hide resolved
'Only one field must be provided.'
),
},
{
fn: exhaustiveExamplesInterface.functions.enum_with_builtin_type,
title: '[enum] - multiple values selected',
value: { a: true, b: 1 },
error: new FuelError(
FuelError.CODES.INVALID_DECODE_VALUE,
petertonysmith94 marked this conversation as resolved.
Show resolved Hide resolved
'Only one field must be provided.'
),
},
{
fn: exhaustiveExamplesInterface.functions.struct_simple,
title: '[struct] - missing property',
value: { a: true },
error: new FuelError(
FuelError.CODES.ENCODE_ERROR,
'Invalid struct SimpleStruct. Field "b" not present.'
),
},
{
fn: exhaustiveExamplesInterface.functions.struct_with_tuple,
title: '[tuple] - extra element',
value: { propB1: [true, U64_MAX, 'extra element'] },
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Types/values length mismatch.'),
},
{
fn: exhaustiveExamplesInterface.functions.struct_with_tuple,
title: '[tuple] - missing element',
value: { propB1: [true] },
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Types/values length mismatch.'),
},
{
fn: exhaustiveExamplesInterface.functions.array_simple,
title: '[array] - input not array',
value: { 0: 'element', 1: 'e', 2: 'e', 3: 'e' },
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Expected array value.'),
},
{
fn: exhaustiveExamplesInterface.functions.array_simple,
title: '[array] - not enough elements',
value: [[1, 2, 3]],
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Types/values length mismatch.'),
},
{
fn: exhaustiveExamplesInterface.functions.array_simple,
title: '[array] - too many elements',
value: [[1, 2, 3, 4, 5]],
error: new FuelError(FuelError.CODES.ENCODE_ERROR, 'Types/values length mismatch.'),
},
])('$title', ({ fn, value }) => {
expect(() =>
Array.isArray(value) ? fn.encodeArguments(value) : fn.encodeArguments([value])
).toThrow();
])('$title', async ({ fn, value, error }) => {
await expectToThrowFuelError(
() => (Array.isArray(value) ? fn.encodeArguments(value) : fn.encodeArguments([value])),
error
);
});
});
});
Expand Down