Skip to content

fix: make unit tests deterministic and skip API-dependent tests without credentials #51

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

Open
fepvenancio wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: make unit tests deterministic and skip API-dependent tests without credentials #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 20 additions & 6 deletions src/api/zero-x-v2/__tests__/zero-x-v2-quote.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,31 +43,45 @@ const runV2QuoteTest = async (amount = '1000000000000000000') => {
expect(quote).to.haveOwnProperty('sellTokenValue');
};

const hasZeroXApiKey = () => testConfig.zeroXApiKey !== '' && testConfig.zeroXApiKey !== 'REPLACE_ME';
const hasZeroXProxy = () => testConfig.zeroXProxyApiDomain !== '' && testConfig.zeroXProxyApiDomain !== 'REPLACE_ME';

describe('zero-x-v2-quote', () => {
let getZeroXV2DataStub: sinon.SinonStub;
before(() => {});

beforeEach(() => {
ZeroXConfig.PROXY_API_DOMAIN = undefined;
ZeroXConfig.API_KEY = testConfig.zeroXApiKey;
});

it('Should fetch quotes from ZeroXV2 proxy', async () => {
it('Should fetch quotes from ZeroXV2 proxy', async function () {
if (!hasZeroXProxy()) {
this.skip();
}
ZeroXConfig.PROXY_API_DOMAIN = testConfig.zeroXProxyApiDomain;
ZeroXConfig.API_KEY = undefined;
await runV2QuoteTest();
}).timeout(10000);

it('Should fetch quotes from ZeroXV2 API Key', async () => {
it('Should fetch quotes from ZeroXV2 API Key', async function () {
if (!hasZeroXApiKey()) {
this.skip();
}
await runV2QuoteTest();
}).timeout(10000);

it('Should fetch quotes from ZeroXV2 API Key with large volume request', async () => {
it('Should fetch quotes from ZeroXV2 API Key with large volume request', async function () {
if (!hasZeroXApiKey()) {
this.skip();
}
await runV2QuoteTest('0x1000000000000000000000');
}).timeout(10000);

it('Should fetch quotes from ZeroXV2 API Key with large volume request and fail', async () => {

it('Should fetch quotes from ZeroXV2 API Key with large volume request and fail', async function () {
if (!hasZeroXApiKey()) {
this.skip();
}
await expect(runV2QuoteTest('0x10000000000000000000000000000000000000000'))
.to.be.rejected;
}).timeout(10000);
Expand Down
14 changes: 14 additions & 0 deletions src/recipes/liquidity/uni-v2-like/__tests__/uniswap-v2-add-liquidity-recipe.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ import {
MOCK_UNSHIELD_FEE_BASIS_POINTS,
} from '../../../../test/mocks.test';
import { UniV2LikePairContract } from '../../../../contract/liquidity/uni-v2-like-pair-contract';
import { UniV2LikeFactoryContract } from '../../../../contract/liquidity/uni-v2-like-factory-contract';
import {
RecipeERC20Info,
RecipeInput,
UniswapV2Fork,
} from '../../../../models/export-models';
import { UniV2LikeAddLiquidityRecipe } from '../uni-v2-like-add-liquidity-recipe';
import { JsonRpcProvider } from 'ethers';
import { ZERO_ADDRESS } from '../../../../models/constants';

chai.use(chaiAsPromised);
const { expect } = chai;
Expand Down Expand Up @@ -45,6 +47,8 @@ const LP_TOKEN: RecipeERC20Info = {
let dateStub: SinonStub;
let uniswapV2PairGetReserves: SinonStub;
let uniswapV2PairTotalSupply: SinonStub;
let uniswapV2PairKLast: SinonStub;
let uniswapV2FactoryFeeTo: SinonStub;

const provider = new JsonRpcProvider('https://eth.llamarpc.com');

Expand All @@ -68,12 +72,22 @@ describe('uniswap-v2-add-liquidity-recipe', () => {
UniV2LikePairContract.prototype,
'totalSupply',
).resolves(oneInDecimals18 * 2_000_000n);
uniswapV2PairKLast = Sinon.stub(
UniV2LikePairContract.prototype,
'kLast',
).resolves(0n);
uniswapV2FactoryFeeTo = Sinon.stub(
UniV2LikeFactoryContract.prototype,
'feeTo',
).resolves(ZERO_ADDRESS);
});

after(() => {
dateStub.restore();
uniswapV2PairGetReserves.restore();
uniswapV2PairTotalSupply.restore();
uniswapV2PairKLast.restore();
uniswapV2FactoryFeeTo.restore();
});

it('Should create uniswap-v2-add-liquidity-recipe', async () => {
Expand Down
14 changes: 14 additions & 0 deletions src/recipes/liquidity/uni-v2-like/__tests__/uniswap-v2-remove-liquidity-recipe.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,15 @@ import {
MOCK_UNSHIELD_FEE_BASIS_POINTS,
} from '../../../../test/mocks.test';
import { UniV2LikePairContract } from '../../../../contract/liquidity/uni-v2-like-pair-contract';
import { UniV2LikeFactoryContract } from '../../../../contract/liquidity/uni-v2-like-factory-contract';
import {
RecipeERC20Info,
RecipeInput,
UniswapV2Fork,
} from '../../../../models/export-models';
import { UniV2LikeRemoveLiquidityRecipe } from '../uni-v2-like-remove-liquidity-recipe';
import { JsonRpcProvider } from 'ethers';
import { ZERO_ADDRESS } from '../../../../models/constants';

chai.use(chaiAsPromised);
const { expect } = chai;
Expand Down Expand Up @@ -45,6 +47,8 @@ const LP_TOKEN: RecipeERC20Info = {
let dateStub: SinonStub;
let uniswapV2PairGetReserves: SinonStub;
let uniswapV2PairTotalSupply: SinonStub;
let uniswapV2PairKLast: SinonStub;
let uniswapV2FactoryFeeTo: SinonStub;

const provider = new JsonRpcProvider('https://eth.llamarpc.com');

Expand All @@ -68,12 +72,22 @@ describe('uniswap-v2-remove-liquidity-recipe', () => {
UniV2LikePairContract.prototype,
'totalSupply',
).resolves(oneInDecimals18 * 2_000_000n);
uniswapV2PairKLast = Sinon.stub(
UniV2LikePairContract.prototype,
'kLast',
).resolves(0n);
uniswapV2FactoryFeeTo = Sinon.stub(
UniV2LikeFactoryContract.prototype,
'feeTo',
).resolves(ZERO_ADDRESS);
});

after(() => {
dateStub.restore();
uniswapV2PairGetReserves.restore();
uniswapV2PairTotalSupply.restore();
uniswapV2PairKLast.restore();
uniswapV2FactoryFeeTo.restore();
});

it('Should create uniswap-v2-remove-liquidity-recipe', async () => {
Expand Down