https://github.com/adaltas/node-ssh2-they

Extends Mocha with the function `they` to transparently run tests in local and ssh mode
https://github.com/adaltas/node-ssh2-they

Last synced: 29 days ago
JSON representation

Extends Mocha with the function `they` to transparently run tests in local and ssh mode

• Host: GitHub
• URL: https://github.com/adaltas/node-ssh2-they
• Owner: adaltas
• License: mit
• Created: 2014-04-14T10:50:36.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2020-12-02T13:56:45.000Z (almost 4 years ago)
• Last Synced: 2024-09-14T12:18:43.438Z (about 2 months ago)
• Language: CoffeeScript
• Size: 42 KB
• Stars: 1
• Watchers: 11
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        

# Node.js ssh2-they

Extends [Mocha][mocha] with a new `they` function replacing `it`. The goal is 

to execute the same test in multiple environments. This package was originally 

written to test [ssh2-fs](https://github.com/adaltas/node-ssh2-fs), [ssh2-exec](https://github.com/adaltas/node-ssh2-exec) and [Nikita](http://nikita.js.org/). For example, in 

those packages, each test is run twice: the first time on a local environment and the second time over SSH.

If no environment is provided, the default behaviour of this package is to attempt to open a passwordless ssh connection on localhost with the current running user. Thus, it expects 

correct deployment of your ssh public key inside your own authorized_key file.

Additionally, you can call the `configure` function with multiple environment parameters. Refer to the ["ssh2-connect"](https://github.com/adaltas/node-ssh2-connect) and ["ssh2"](https://github.com/mscdex/ssh2) packages for a complete list of supported options.

## Installation

This is OSS and licensed under the [new BSD license][license].

```bash

npm install ssh2-fs

```

## Examples

The below examples found inspiration in the [exists test](https://github.com/adaltas/node-ssh2-fs/blob/master/test/exists.coffee) of the [ssh2-fs module](https://github.com/adaltas/node-ssh2-fs).

This test will connect to localhost with the current working user:

```js

const should = require('should')

const fs = require('ssh2-fs')

const they = require('ssh2-they')

describe('exists', function(){

  they('on file', function({ssh}, next){

    fs.exists( ssh, "#{__filename}", function(err, exists){

      exists.should.be.true()

      next()

    })

  })

})

```

This test will attempt a remote connection using the root user:

```js

const should = require('should')

const fs = require('ssh2-fs')

const they = require('ssh2-they').configure([

  null,

  {

    debug: true,

    ssh: null

  }, {

    debug: true,

    ssh: {

      host: 'localhost',

      port: 22,

      username: 'root',

      privateKey: require('fs').readFileSync('/here/is/my/key')

    }

  }

])

describe('exists', function(){

  they('on file', function({debug, ssh}, next){

    fs.exists( ssh, "#{__filename}", function(err, exists){

      exists.should.be.true()

      next()

    })

  })

})

```

## Travis integration

You can make it work with [Travis][travis] by adding the following lines to 

your ".travis.yml" file:

before_script:

  - "ssh-keygen -t rsa -f ~/.ssh/id_rsa -N ''"

  - "cat ~/.ssh/id_rsa.pub > ~/.ssh/authorized_keys"

## Contributors

*   David Worms: 

[ssh2]: https://github.com/mscdex/ssh2

[license]: https://github.com/adaltas/node-ssh2-they/blob/master/LICENSE.md

[travis]: https://travis-ci.org/