Skip to content

refactor: extract jest matchers into its own package #1926

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

Merged
faustbrian merged 2 commits into from
Jan 3, 2019
Merged

refactor: extract jest matchers into its own package #1926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ae5e0b9
refactor: extract jest matchers into its own package
Jan 3, 2019
cb3949b
fix(core-test-utils): import core-jest-matchers instead of local files
Jan 3, 2019
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
118 changes: 66 additions & 52 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand All @@ -64,26 +65,29 @@ jobs:
name: Create .ark/database directory
command: mkdir -p $HOME/.ark/database
- run:
name: core-webhooks
command: 'cd ~/ark-core/packages/core-webhooks && yarn test:coverage'
name: core-vote-report
command: 'cd ~/ark-core/packages/core-vote-report && yarn test:coverage'
- run:
name: core-transaction-pool
command: 'cd ~/ark-core/packages/core-transaction-pool && yarn test:coverage'
name: core-tester-cli
command: 'cd ~/ark-core/packages/core-tester-cli && yarn test:coverage'
- run:
name: core-logger-winston
command: 'cd ~/ark-core/packages/core-logger-winston && yarn test:coverage'
name: core-snapshots
command: 'cd ~/ark-core/packages/core-snapshots && yarn test:coverage'
- run:
name: core-api
command: 'cd ~/ark-core/packages/core-api && yarn test:coverage'
name: core-logger
command: 'cd ~/ark-core/packages/core-logger && yarn test:coverage'
- run:
name: core-graphql
command: 'cd ~/ark-core/packages/core-graphql && yarn test:coverage'
- run:
name: core-debugger-cli
command: 'cd ~/ark-core/packages/core-debugger-cli && yarn test:coverage'
- run:
name: core-container
command: 'cd ~/ark-core/packages/core-container && yarn test:coverage'
- run:
name: core-graphql
command: 'cd ~/ark-core/packages/core-graphql && yarn test:coverage'
name: core-http-utils
command: 'cd ~/ark-core/packages/core-http-utils && yarn test:coverage'
- run:
name: Last 1000 lines of test output
when: on_fail
Expand Down Expand Up @@ -137,6 +141,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand All @@ -155,26 +160,29 @@ jobs:
name: Create .ark/database directory
command: mkdir -p $HOME/.ark/database
- run:
name: core-webhooks
command: 'cd ~/ark-core/packages/core-webhooks && yarn test:coverage'
name: core-vote-report
command: 'cd ~/ark-core/packages/core-vote-report && yarn test:coverage'
- run:
name: core-transaction-pool
command: 'cd ~/ark-core/packages/core-transaction-pool && yarn test:coverage'
name: core-tester-cli
command: 'cd ~/ark-core/packages/core-tester-cli && yarn test:coverage'
- run:
name: core-logger-winston
command: 'cd ~/ark-core/packages/core-logger-winston && yarn test:coverage'
name: core-snapshots
command: 'cd ~/ark-core/packages/core-snapshots && yarn test:coverage'
- run:
name: core-api
command: 'cd ~/ark-core/packages/core-api && yarn test:coverage'
name: core-logger
command: 'cd ~/ark-core/packages/core-logger && yarn test:coverage'
- run:
name: core-graphql
command: 'cd ~/ark-core/packages/core-graphql && yarn test:coverage'
- run:
name: core-debugger-cli
command: 'cd ~/ark-core/packages/core-debugger-cli && yarn test:coverage'
- run:
name: core-container
command: 'cd ~/ark-core/packages/core-container && yarn test:coverage'
- run:
name: core-graphql
command: 'cd ~/ark-core/packages/core-graphql && yarn test:coverage'
name: core-http-utils
command: 'cd ~/ark-core/packages/core-http-utils && yarn test:coverage'
- run:
name: Last 1000 lines of test output
when: on_fail
Expand Down Expand Up @@ -228,6 +236,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand Down Expand Up @@ -307,6 +316,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand All @@ -325,17 +335,17 @@ jobs:
name: Create .ark/database directory
command: mkdir -p $HOME/.ark/database
- run:
name: core-utils
command: 'cd ~/ark-core/packages/core-utils && yarn test:coverage'
name: core-webhooks
command: 'cd ~/ark-core/packages/core-webhooks && yarn test:coverage'
- run:
name: core-test-utils
command: 'cd ~/ark-core/packages/core-test-utils && yarn test:coverage'
name: core-transaction-pool
command: 'cd ~/ark-core/packages/core-transaction-pool && yarn test:coverage'
- run:
name: core-p2p
command: 'cd ~/ark-core/packages/core-p2p && yarn test:coverage'
name: core-logger-winston
command: 'cd ~/ark-core/packages/core-logger-winston && yarn test:coverage'
- run:
name: core-http-utils
command: 'cd ~/ark-core/packages/core-http-utils && yarn test:coverage'
name: core-api
command: 'cd ~/ark-core/packages/core-api && yarn test:coverage'
- run:
name: core-event-emitter
command: 'cd ~/ark-core/packages/core-event-emitter && yarn test:coverage'
Expand Down Expand Up @@ -398,6 +408,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand All @@ -416,17 +427,17 @@ jobs:
name: Create .ark/database directory
command: mkdir -p $HOME/.ark/database
- run:
name: core-vote-report
command: 'cd ~/ark-core/packages/core-vote-report && yarn test:coverage'
name: core-utils
command: 'cd ~/ark-core/packages/core-utils && yarn test:coverage'
- run:
name: core-tester-cli
command: 'cd ~/ark-core/packages/core-tester-cli && yarn test:coverage'
name: core-test-utils
command: 'cd ~/ark-core/packages/core-test-utils && yarn test:coverage'
- run:
name: core-snapshots
command: 'cd ~/ark-core/packages/core-snapshots && yarn test:coverage'
name: core-p2p
command: 'cd ~/ark-core/packages/core-p2p && yarn test:coverage'
- run:
name: core-logger
command: 'cd ~/ark-core/packages/core-logger && yarn test:coverage'
name: core-jest-matchers
command: 'cd ~/ark-core/packages/core-jest-matchers && yarn test:coverage'
- run:
name: core-forger
command: 'cd ~/ark-core/packages/core-forger && yarn test:coverage'
Expand Down Expand Up @@ -486,6 +497,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand Down Expand Up @@ -565,6 +577,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand All @@ -583,17 +596,17 @@ jobs:
name: Create .ark/database directory
command: mkdir -p $HOME/.ark/database
- run:
name: core-utils
command: 'cd ~/ark-core/packages/core-utils && yarn test:coverage'
name: core-webhooks
command: 'cd ~/ark-core/packages/core-webhooks && yarn test:coverage'
- run:
name: core-test-utils
command: 'cd ~/ark-core/packages/core-test-utils && yarn test:coverage'
name: core-transaction-pool
command: 'cd ~/ark-core/packages/core-transaction-pool && yarn test:coverage'
- run:
name: core-p2p
command: 'cd ~/ark-core/packages/core-p2p && yarn test:coverage'
name: core-logger-winston
command: 'cd ~/ark-core/packages/core-logger-winston && yarn test:coverage'
- run:
name: core-http-utils
command: 'cd ~/ark-core/packages/core-http-utils && yarn test:coverage'
name: core-api
command: 'cd ~/ark-core/packages/core-api && yarn test:coverage'
- run:
name: core-event-emitter
command: 'cd ~/ark-core/packages/core-event-emitter && yarn test:coverage'
Expand Down Expand Up @@ -656,6 +669,7 @@ jobs:
- ./packages/core-forger/node_modules
- ./packages/core-graphql/node_modules
- ./packages/core-http-utils/node_modules
- ./packages/core-jest-matchers/node_modules
- ./packages/core-json-rpc/node_modules
- ./packages/core-logger/node_modules
- ./packages/core-logger-winston/node_modules
Expand All @@ -674,17 +688,17 @@ jobs:
name: Create .ark/database directory
command: mkdir -p $HOME/.ark/database
- run:
name: core-vote-report
command: 'cd ~/ark-core/packages/core-vote-report && yarn test:coverage'
name: core-utils
command: 'cd ~/ark-core/packages/core-utils && yarn test:coverage'
- run:
name: core-tester-cli
command: 'cd ~/ark-core/packages/core-tester-cli && yarn test:coverage'
name: core-test-utils
command: 'cd ~/ark-core/packages/core-test-utils && yarn test:coverage'
- run:
name: core-snapshots
command: 'cd ~/ark-core/packages/core-snapshots && yarn test:coverage'
name: core-p2p
command: 'cd ~/ark-core/packages/core-p2p && yarn test:coverage'
- run:
name: core-logger
command: 'cd ~/ark-core/packages/core-logger && yarn test:coverage'
name: core-jest-matchers
command: 'cd ~/ark-core/packages/core-jest-matchers && yarn test:coverage'
- run:
name: core-forger
command: 'cd ~/ark-core/packages/core-forger && yarn test:coverage'
Expand Down
11 changes: 11 additions & 0 deletions packages/core-jest-matchers/.gitattributes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html

# Ignore all test and documentation with "export-ignore".
/.editorconfig export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/__tests__ export-ignore
/docs export-ignore
/README.md export-ignore
24 changes: 24 additions & 0 deletions packages/core-jest-matchers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Ark Core - Jest Matchers

<p align="center">
<img src="../../banner.png?sanitize=true" />
</p>

## Documentation

You can find installation instructions and detailed instructions on how to use this package at the [dedicated documentation site](https://docs.ark.io/guidebook/core/plugins/core-jest-matchers.html).

## Security

If you discover a security vulnerability within this package, please send an e-mail to security@ark.io. All security vulnerabilities will be promptly addressed.

## Credits

- [Brian Faust](https://github.com/faustbrian)
- [Erwann Gentric](https://github.com/air1one)
- [Joshua Noack](https://github.com/supaiku0)
- [All Contributors](../../../../contributors)

## License

[MIT](LICENSE) © [ArkEcosystem](https://ark.io)
2 changes: 1 addition & 1 deletion ...ts__/matchers/blockchain/dispatch.test.ts → ...ers/__tests__/blockchain/dispatch.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../src/matchers/blockchain/dispatch";
import "../../src/blockchain/dispatch";

describe(".toDispatch", () => {
const blockchain = {
Expand Down
2 changes: 1 addition & 1 deletion ...chers/blockchain/execute-on-entry.test.ts → ...sts__/blockchain/execute-on-entry.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Machine } from "xstate";
import "../../../src/matchers/blockchain/execute-on-entry";
import "../../src/blockchain/execute-on-entry";

describe(".toExecuteOnEntry", () => {
const machine = Machine({
Expand Down
2 changes: 1 addition & 1 deletion ...__/matchers/blockchain/transition.test.ts → ...s/__tests__/blockchain/transition.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Machine } from "xstate";
import "../../../src/matchers/blockchain/transition";
import "../../src/blockchain/transition";

describe(".toTransition", () => {
const machine = Machine({
Expand Down
2 changes: 1 addition & 1 deletion ...__tests__/matchers/fields/address.test.ts → ...matchers/__tests__/fields/address.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../src/matchers/fields/address";
import "../../src/fields/address";

describe(".toBeArkAddress", () => {
test("passes when given a valid address", () => {
Expand Down
2 changes: 1 addition & 1 deletion ...ests__/matchers/fields/public-key.test.ts → ...chers/__tests__/fields/public-key.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../src/matchers/fields/public-key";
import "../../src/fields/public-key";

describe(".toBeArkPublicKey", () => {
test("passes when given a valid public key", () => {
Expand Down
2 changes: 1 addition & 1 deletion ..._tests__/matchers/models/delegate.test.ts → ...atchers/__tests__/models/delegate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../src/matchers/models/delegate";
import "../../src/models/delegate";

describe(".toBeDelegate", () => {
const delegate = {
Expand Down
2 changes: 1 addition & 1 deletion ...sts__/matchers/models/transaction.test.ts → ...hers/__tests__/models/transaction.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../src/matchers/models/transaction";
import "../../src/models/transaction";

describe(".toBeTransaction", () => {
const transaction = {
Expand Down
2 changes: 1 addition & 1 deletion .../__tests__/matchers/models/wallet.test.ts → ...-matchers/__tests__/models/wallet.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../src/matchers/models/wallet";
import "../../src/models/wallet";

describe(".toBeWallet", () => {
const wallet = {
Expand Down
2 changes: 1 addition & 1 deletion ...ctions/types/delegate-resignation.test.ts → ...ctions/types/delegate-resignation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/delegate-resignation";
import "../../../src/transactions/types/delegate-resignation";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion ...chers/transactions/types/delegate.test.ts → ...sts__/transactions/types/delegate.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/delegate";
import "../../../src/transactions/types/delegate";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion .../matchers/transactions/types/ipfs.test.ts → ...__tests__/transactions/types/ipfs.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/ipfs";
import "../../../src/transactions/types/ipfs";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion .../transactions/types/multi-payment.test.ts → .../transactions/types/multi-payment.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/multi-payment";
import "../../../src/transactions/types/multi-payment";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion ...ransactions/types/multi-signature.test.ts → ...ransactions/types/multi-signature.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/multi-signature";
import "../../../src/transactions/types/multi-signature";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion ...ansactions/types/second-signature.test.ts → ...ansactions/types/second-signature.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/second-signature";
import "../../../src/transactions/types/second-signature";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion ...nsactions/types/timelock-transfer.test.ts → ...nsactions/types/timelock-transfer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/timelock-transfer";
import "../../../src/transactions/types/timelock-transfer";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion ...chers/transactions/types/transfer.test.ts → ...sts__/transactions/types/transfer.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/transfer";
import "../../../src/transactions/types/transfer";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
2 changes: 1 addition & 1 deletion .../matchers/transactions/types/vote.test.ts → ...__tests__/transactions/types/vote.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import "../../../../src/matchers/transactions/types/vote";
import "../../../src/transactions/types/vote";

import { constants } from "@arkecosystem/crypto";
const { TransactionTypes } = constants;
Expand Down
Loading