{"_id":"@aragonite/vbox-runner","_rev":"4-ddc9d8a4e27ea287092d62305ff7ccc9","name":"@aragonite/vbox-runner","description":"Connects to an Aragonite server from inside a VirtualBox environment.","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@aragonite/vbox-runner","version":"0.0.1","description":"Connects to an Aragonite server from inside a VirtualBox environment.","main":"VBoxRunner.js","bin":{"aragonite-vbox-runner":"./bin/aragonite-vbox-runner.js"},"scripts":{"test":"mocha"},"repository":{"type":"git","url":"git+https://github.com/rweda/aragonite-vbox-runner.git"},"author":{"name":"Ryan Leonard","url":"http://ryanleonard.us"},"publishConfig":{"registry":"http://registry.npmjs.org/","access":"public"},"license":"MIT","bugs":{"url":"https://github.com/rweda/aragonite-vbox-runner/issues"},"homepage":"https://github.com/rweda/aragonite-vbox-runner#readme","dependencies":{"bluebird":"^3.4.7","child-process-promise":"^2.2.0","commander":"^2.9.0","custom-error":"^0.2.1","event-to-promise":"^0.7.0","js-yaml":"^3.7.0","network":"^0.3.2","socket.io-client":"^1.7.2"},"devDependencies":{"chai":"^3.5.0","express":"^4.14.0","mocha":"^3.2.0","socket.io":"^1.7.2"},"gitHead":"c379deb6c8f832290ffcd9a757a788534540c8f6","_id":"@aragonite/vbox-runner@0.0.1","_shasum":"bb663965b50a368865ddbafed81577e1b7c5de58","_from":".","_npmVersion":"3.9.6","_nodeVersion":"5.8.0","_npmUser":{"name":"aragonite","email":"rhinoisnot+aragonite@gmail.com"},"dist":{"shasum":"bb663965b50a368865ddbafed81577e1b7c5de58","tarball":"https://registry.npmjs.org/@aragonite/vbox-runner/-/vbox-runner-0.0.1.tgz","integrity":"sha512-geco1KP3kcxCcqFSzfQPPtoGuGVzTFpVa6yxDstKiWnCh0k/TwZS869kIpWSycXXJl8PVLAq4nNUDrpz3EnZAw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCUqNdd+ryrrFI4dZ5kjTR+v63khaeLmfu40Q0M91CT5QIgXeB0H3R8dRmsLRvsDfVmrlE1ZXh2gdXgJZKbGKkRxGA="}]},"maintainers":[{"name":"aragonite","email":"rhinoisnot+aragonite@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/vbox-runner-0.0.1.tgz_1485192541116_0.6780673710163683"}},"0.0.2":{"name":"@aragonite/vbox-runner","version":"0.0.2","description":"Connects to an Aragonite server from inside a VirtualBox environment.","main":"VBoxRunner.js","bin":{"aragonite-vbox-runner":"./bin/aragonite-vbox-runner.js"},"scripts":{"test":"mocha"},"repository":{"type":"git","url":"git+https://github.com/rweda/aragonite-vbox-runner.git"},"author":{"name":"Ryan Leonard","url":"http://ryanleonard.us"},"publishConfig":{"registry":"http://registry.npmjs.org/","access":"public"},"license":"MIT","bugs":{"url":"https://github.com/rweda/aragonite-vbox-runner/issues"},"homepage":"https://github.com/rweda/aragonite-vbox-runner#readme","dependencies":{"bluebird":"^3.4.7","child-process-promise":"^2.2.0","commander":"^2.9.0","custom-error":"^0.2.1","event-to-promise":"^0.7.0","js-yaml":"^3.7.0","network":"^0.3.2","socket.io-client":"^1.7.2"},"devDependencies":{"chai":"^3.5.0","express":"^4.14.0","mocha":"^3.2.0","socket.io":"^1.7.2"},"gitHead":"66c2b459eefe3c0370696165738cddf834a2eafe","_id":"@aragonite/vbox-runner@0.0.2","_shasum":"439c0123fd2fa202d5ff77240968e3c19a9e1862","_from":".","_npmVersion":"3.9.6","_nodeVersion":"5.8.0","_npmUser":{"name":"codelenny","email":"rhinoisnot@gmail.com"},"dist":{"shasum":"439c0123fd2fa202d5ff77240968e3c19a9e1862","tarball":"https://registry.npmjs.org/@aragonite/vbox-runner/-/vbox-runner-0.0.2.tgz","integrity":"sha512-rdPGtcJ3a6UuNA8O0zG8kQ3Co5udLhG80K7/50/dXMq4YjOxLyyR2KbZ48VpHx+10Fv0B/exvmWXHqRuM3zvBQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIGPkI/Q5BR3OmjLZEuwwbHTfroNSr5nRZEs/SpUka1EPAiEAnMfk+GbfmOU46FbwwAFirfuscokEhuKj4vguq1ULbuA="}]},"maintainers":[{"name":"aragonite","email":"rhinoisnot+aragonite@gmail.com"},{"name":"codelenny","email":"rhinoisnot@gmail.com"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/vbox-runner-0.0.2.tgz_1485207487566_0.5951539308298379"}}},"readme":"# Aragonite VirtualBox Runner\n\nThis runner provides an easy way to communicate with an [Aragonite][] testing server from inside a VirtualBox to collect\nthe current test details, and report the testing results back to the server.\n\nThis package includes a communication library, ~~[`VBoxRunner.js`][]~~ that uses the ~~[`aragonite-vbox` API][]~~.\n\nIn addition to the library, a CLI utility (`vbox-runner`) provides a self-contained testing system that defines tasks to\nrun in a YAML file, similar to the files used by [GitLab CI][] and [Travis CI][].\n\n## CLI Usage\n\n### 1. YAML File\n\n`vbox-runner` uses a YAML file to configure functionality.  A sample file is below.\n\n```yml\nport: 5720\nrepo: git\ncwd: \"~/my-project\"\nignore_failure: true\nscript:\n  - echo \"Success 55\"\n  - echo \"Failure 12\"\nformat: \"goodbad\"\ngoodbad:\n  success: \"Passed successfully\"\n  good: \"Success ([0-9]+)\"\n  bad: \"Failure ([0-9]+)\"\n  duration: \"Total ([0-9]+)ms\"  \n```\n\n#### Connection\n\nThe runner needs to connect to an `aragonite-vbox` instance on an Aragonite server.  By default, it connects to the\ngateway IP, which is the host machine's IP address if VirtualBox's network is set to NAT.\n\nAlternatively, `host` can be set to an IP address or URL of the Aragonite server.\n\n`aragonite-vbox` defaults to using port `5720`.  Provide a `port` entry if the port has been changed in the Aragonite\nconfiguration.\n\n#### Project Importing\n\nThe runner can automatically get files needed to test the project, and place them in the directory specified by `cwd`\n(defaulting to `~`).\n\nIf `repo` is provided, the runner will attempt to fetch the project's files from the repository specified in the run\nconfiguration passed to Aragonite using the software specified by `repo`.  Currently, only `git` is supported.\n\nIf `repo` isn't provided, the runner will download and unpack a file archive, if one was provided to the Aragonite run.\nThis can be disabled by setting `no-archive: true` in the configuration.\n\n#### Test Commands\n\nThe runner will run shell commands specified by `script`.  Unless `ignore_failure: true` is provided in the YAML file,\nany script failures will abort the entire environment, and report an error to Aragonite.\n\n#### Success/Failure parsing\n\nAragonite supports multiple formats of reports, to support different types of applications.\n\nSpecify the report format with `format`, e.g. `\"goodbad\"`.\n\nReport formats might define additional options, such as regular expressions to parse log outputs.\n\n### 2. Installation\n\nInside a VirtualBox machine, install Node.js and Git, and then run `npm install [-g] @aragonite/vbox-runner`.\n\nHave a script run on machine startup that calls `aragonite-vbox-runner <YAML path>`, calling the CLI command wherever it\nwas installed, and providing the path to the YAML file containing the run configuration.\n\n[Aragonite]: https://github.com/rweda/aragonite\n[`VBoxRunner.js`]: https://rweda.github.io/aragonite-vbox-runner\n[`aragonite-vbox` API]: https://rweda.github.io/aragonite\n[GitLab CI]: https://about.gitlab.com/gitlab-ci/\n[Travis CI]: https://travis-ci.org/\n","maintainers":[{"name":"aragonite","email":"rhinoisnot+aragonite@gmail.com"},{"name":"codelenny","email":"rhinoisnot@gmail.com"}],"time":{"modified":"2022-06-12T14:47:01.659Z","created":"2017-01-23T17:29:02.925Z","0.0.1":"2017-01-23T17:29:02.925Z","0.0.2":"2017-01-23T21:38:09.442Z"},"homepage":"https://github.com/rweda/aragonite-vbox-runner#readme","repository":{"type":"git","url":"git+https://github.com/rweda/aragonite-vbox-runner.git"},"author":{"name":"Ryan Leonard","url":"http://ryanleonard.us"},"bugs":{"url":"https://github.com/rweda/aragonite-vbox-runner/issues"},"license":"MIT","readmeFilename":"README.md"}