Merge pull request #93 from AthennaIO/develop

Add debuglog and fix annotation types

bin/test.ts

@@ -7,11 +7,11 @@
  * file that was distributed with this source code.
  */
 
-import { Runner, assert, specReporter } from '#src'
+import { Runner } from '#src'
 
 await Runner.setTsEnv()
-  .addPlugin(assert())
-  .addReporter(specReporter())
+  .addAssertPlugin()
+  .addSpecReporter()
   .addPath('tests/unit/**/*Test.ts')
   .setCliArgs(process.argv.slice(2))
   .setGlobalTimeout(10000)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/test",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "The Athenna test runner. Built on top of Japa.",
   "license": "MIT",
   "author": "João Lenon <lenon@athenna.io>",
@@ -44,23 +44,24 @@
     "#src/*": "./src/*.js",
     "#src": "./src/index.js",
     "#src/types": "./src/types/index.js",
+    "#src/debug": "./src/debug/index.js",
     "#tests/*": "./tests/*.js",
     "#tests": "./tests/index.js"
   },
   "dependencies": {
-    "@japa/assert": "^1.3.6",
+    "@japa/assert": "^1.4.1",
     "@japa/run-failed-tests": "^1.1.0",
     "@japa/runner": "^2.2.2",
-    "@japa/spec-reporter": "^1.3.2",
-    "@types/sinon": "^10.0.13",
-    "sinon": "^15.0.1"
+    "@japa/spec-reporter": "^1.3.3",
+    "@types/sinon": "^10.0.15",
+    "sinon": "^15.1.0"
   },
   "devDependencies": {
-    "@athenna/common": "^3.6.0",
+    "@athenna/common": "^4.2.0",
     "@typescript-eslint/eslint-plugin": "^5.56.0",
     "@typescript-eslint/parser": "^5.56.0",
     "c8": "^5.0.2",
-    "commitizen": "^4.2.6",
+    "commitizen": "^4.3.0",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.36.0",

src/decorators/AfterAll.ts → src/annotations/AfterAll.ts

@@ -9,7 +9,7 @@
 
 import 'reflect-metadata'
 
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Create a new after all (teardown) hook.
@@ -18,7 +18,7 @@ export function AfterAll(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const afterAllHooks = Reflect.getMetadata('hooks:afterAll', Target)
 

src/decorators/AfterEach.ts → src/annotations/AfterEach.ts

@@ -9,7 +9,7 @@
 
 import 'reflect-metadata'
 
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Create a new after each (teardown.each) hook.
@@ -18,7 +18,7 @@ export function AfterEach(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const afterEachHooks = Reflect.getMetadata('hooks:afterEach', Target)
 

src/decorators/BeforeAll.ts → src/annotations/BeforeAll.ts

@@ -9,7 +9,7 @@
 
 import 'reflect-metadata'
 
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Create a new before all (setup) hook.
@@ -18,7 +18,7 @@ export function BeforeAll(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const beforeAllHooks = Reflect.getMetadata('hooks:beforeAll', Target)
 

src/decorators/BeforeEach.ts → src/annotations/BeforeEach.ts

@@ -9,7 +9,7 @@
 
 import 'reflect-metadata'
 
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Create a new before each (setup.each) hook.
@@ -18,7 +18,7 @@ export function BeforeEach(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const beforeEachHooks = Reflect.getMetadata('hooks:beforeEach', Target)
 

src/decorators/Cleanup.ts → src/annotations/Cleanup.ts

@@ -9,9 +9,9 @@
 
 import 'reflect-metadata'
 
-import type { Context, CleanupHandler } from '#src/types'
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
+import type { Context, CleanupHandler } from '#src/types'
 
 /**
  * Register a cleanup hook from within the test.
@@ -20,7 +20,7 @@ export function Cleanup(handler: CleanupHandler<Context>): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/DisableTimeout.ts → src/annotations/DisableTimeout.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Disable test timeout. It is the same as calling `test.timeout(0)`
@@ -19,7 +19,7 @@ export function DisableTimeout(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Fails.ts → src/annotations/Fails.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Expect the test to fail. Helpful in creating test cases to
@@ -20,7 +20,7 @@ export function Fails(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Pin.ts → src/annotations/Pin.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Pin the test. If one test is pinned, Japa will run only pinned tests.
@@ -19,7 +19,7 @@ export function Pin(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Retry.ts → src/annotations/Retry.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Configure the number of times this test should be retried when failing.
@@ -19,7 +19,7 @@ export function Retry(times: number): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Setup.ts → src/annotations/Setup.ts

@@ -9,9 +9,9 @@
 
 import 'reflect-metadata'
 
-import type { Context, SetupHandler } from '#src/types'
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
+import type { Context, SetupHandler } from '#src/types'
 
 /**
  * Register a setup hook from within the test.
@@ -20,7 +20,7 @@ export function Setup(handler: SetupHandler<Context>): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Skip.ts → src/annotations/Skip.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Skip the test conditionally.
@@ -19,7 +19,7 @@ export function Skip(reason?: string): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Tags.ts → src/annotations/Tags.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Assign tags to the test. Later you can use the tags to run specific tests.
@@ -19,7 +19,7 @@ export function Tags(tags: string[]): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Teardown.ts → src/annotations/Teardown.ts

@@ -9,9 +9,9 @@
 
 import 'reflect-metadata'
 
-import type { Context, TeardownHandler } from '#src/types'
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
+import type { Context, TeardownHandler } from '#src/types'
 
 /**
  * Register a teardown hook from within the test.
@@ -20,7 +20,7 @@ export function Teardown(handler: TeardownHandler<Context>): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/Test.ts → src/annotations/Test.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Create a new test.
@@ -19,7 +19,7 @@ export function Test(title?: string): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/TestCase.ts → src/annotations/TestCase.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Define the dataset for the test case. The test executor will be invoked
@@ -20,7 +20,7 @@ export function TestCase(value: any): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
     const cases = tests.get(`${property}.with`, [])

src/decorators/Timeout.ts → src/annotations/Timeout.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Set the test timeout.
@@ -19,7 +19,7 @@ export function Timeout(timeout: number): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)
 

src/decorators/WaitForDone.ts → src/annotations/WaitForDone.ts

@@ -10,7 +10,7 @@
 import 'reflect-metadata'
 
 import { ObjectBuilder } from '@athenna/common'
-import { Decorator } from '#src/helpers/Decorator'
+import { Annotation } from '#src/helpers/Annotation'
 
 /**
  * Wait for the test executor to call done method.
@@ -19,7 +19,7 @@ export function WaitForDone(): MethodDecorator {
   return (target: any, property: string, _: any) => {
     const Target = target.constructor
 
-    Decorator.defineDefaultMetadata(Target)
+    Annotation.defineDefaultMetadata(Target)
 
     const tests: ObjectBuilder = Reflect.getMetadata('tests', Target)