michaelthe/puppyjs

puppeteer + jest + awesome-code = puppyjs

puppyjs's Issues

Generate new tests

Create a command so the user can create new tests using CLI.
For example $ puppy new test testname should create a new file testname.pup.js in e2e folder with basic structure like

describe('description', () => {

  let page

  beforeEach(async () => {
    page = await puppy.newPage()
  })

  afterEach(async () => {
    await page.close()
  })

  it('should ', async function () {
     
  })

})

improve colour coding

i believe we should move the colours to a separate file so that we can have a specific colour coding in logs

Ability to pass devtools, viewport and window size options

Since puppy uses these three options already in puppeteer for running tests, it would be good to have them exposed to the end user as well.

cors not working sometimes

if you setup socket on a separate port cors doesn't work

create puppy website

use vuepress and netlify

Documentation is missing key information

Enrich the documentation and cover the following topics

• Testing config

• Available helper methods for testing

• Available helper endpoints for development

How to use puppy serve with sockets?

I am looking to run puppyjs in serve mode using sockets.

It seems that the current implementation allows puppy to emit messages, but I don't see how to configure puppyjs to listen for a message (as you can with the http api). Is this possible? If so, are there any examples?

Have more loose control over the method names in puppy.api.js

Right now puppy only support using uppercase methods for each route

example

'/api/user': {
    headers: {
      'Authorization': 'Bearer some-token'
    },
    'PATCH': {
      body: 'hello from a PATCH'
    }
  }

to make puppy more robust it should work even when using 'patCh'

change register data to body

from

await puppy.register({path: '/api/user', method: 'patch', data: 'updated user'})

to

await puppy.register({path: '/api/user', method: 'patch', **body**: 'updated user'})

Puppy crashes when reloading puppy.api.js if the file is not syntactically correct

Due to human error, puppy.api.js might have syntax errors. Hence when puppy tries to reload the puppy.api.js it fails and the process exits.

API headers definition could be simplified

Instead of defining the headers in the puppy.api.js like the following

'/api/users': {
    'GET': {
      headers: [
        {
          key: 'X-Session-ID',
          value: '234905823409578'
        }
      ],
      status: 200,
      body: 'hello its a GET'
    }
}

To this

'/api/users': {
    'GET': {
      headers: [
        {
          'X-Session-ID' :  '234905823409578'
        }
      ],
      status: 200,
      body: 'hello its a GET'
    }
}

Ability to hot reload static directory when changes are made

For example in an Angular app, you would use ng build -w which will create a dist folder and puppy would server index.html. However if you make changes to the angular app, you need to manually reload the page.

For convenience it would be great to have live-reload functionality.

Ability to turn off --inspect flag

Right now the flag is hardcoded for node --inspect. User should have the ability to add it as an argument possibly as a --debug flag.

--verbose

verbose is not working properly

Rename .e2e.js tests to .pup.js

Instead of having our test files end in .e2e.js we can change that to .pup.js. Aside from "branding", the user might have other tests that end to .e2e.js and run by another tool in the same project.

Another requirement is that the user must be able to define the extension that puppy will recognise to run the tests by defining it in the puppy.config.js file and optionally add an argument to the command for the same.

e.g puppy test --ext-prefix=e2e

Default body response in puppy.api.js is not JSON formatted

The default 'EMPTY-BODY' response is not JSON.stringified which causes problems e.g with Angular HttpClient, it cannot parse the body.

The suggestion is to remove the default body completely.

Define a web socket spec

Introduce a web socket spec for easily mocking web socket messages.

Sample file

const users = [
  {name: 'Andrew', email: '[email protected]', age: 44},
  {name: 'Kostis', email: '[email protected]', age: 35}
]

module.exports = [
  {
    delay: 1000,
    interval: 1000,
    messages: [
      users,
      {seen: false, createdAt: Date.now(), text: 'I am a notification'}
    ]
  },
  {
    messages: async () => {
      const items = [12,3,52,23]
      return items[Math.floor(Math.random()*items.length)]
    },
    interval: 3000
  }
]

Pull request #12

puppy.ws.api can be simplified

From this

const users = [
  {name: 'Andrew', email: '[email protected]', age: 44},
  {name: 'Kostis', email: '[email protected]', age: 35}
]

module.exports = [
  {
    delay: 1000,
    interval: 1000,
    messages: [
      users,
      {seen: false, createdAt: Date.now(), text: 'I am a notification'}
    ]
  },
  {
    messages: async () => {
      const items = [12,3,52,23]
      return items[Math.floor(Math.random()*items.length)]
    },
    interval: 3000
  }
]

To this

const users = [
  {name: 'Andrew', email: '[email protected]', age: 44},
  {name: 'Kostis', email: '[email protected]', age: 35}
]

module.exports = {
  'notification': {
    delay: 1000,
    interval: 1000,
    message: [
      users,
      {seen: false, createdAt: Date.now(), text: 'I am a notification'}
    ]
  },
  'randomNumber': {
    interval: 3000,
    message: async () => {
      const items = [12, 3, 52, 23, 55]
      return items[Math.floor(Math.random() * items.length)]
    }
  }
}

improve tests

write more tests that will cover more cases eg.
file reloads
flash registered responses