-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from bchr02/add-tests
**Changes:**
* adds test\test.js with over 97% line coverage.
* added a test and coverage section to package.json's scripts property.
* added some dev dependencies to package.json which are needed for testing and code coverage.
* removed some unneeded dependencies from package.json
* removed some unneeded modules that were required in index.js
* ```NodePreGypGithub.prototype.github = new GitHubApi(..)``` now happens immediatelly instead of within ```NodePreGypGithub.prototype.init()```. The main reason for this was so I could provide a replacement mock to use within unit tests.
* added some missing escape characters, so ```/{version}/g``` is now ```/\{version\}/g```- Loading branch information
Showing
3 changed files
with
169 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| "use strict"; | ||
|
|
||
| var expect = require("chai").expect; | ||
| var fs = require("fs"); | ||
| var Index = require('../index.js'); | ||
| var index = new Index(); | ||
| var stage_dir = index.stage_dir; | ||
| var reset_index = function(index_string_ref) { | ||
| delete require.cache[require.resolve(index_string_ref)]; | ||
| return require(index_string_ref); | ||
| }; | ||
| var reset_mocks = function() { | ||
| process.env['NODE_PRE_GYP_GITHUB_TOKEN'] = "secret"; | ||
| fs = reset_index('fs'); | ||
| fs.readFileSync = function(){return '{"name":"test","version":"0.0.1","repository": {"url":"git+https://github.com/test/test.git"},"binary":{"host":"https://github.com/test/test/releases/download/","remote_path":"{version}"}}';}; | ||
| index.stage_dir = stage_dir; | ||
| index.github.authenticate = function(){}; | ||
| index.github.releases.listReleases = function(options, cb){ | ||
| cb(null, [{"tag_name":"0.0.0","assets":[{"name":"filename"}]}]); | ||
| }; | ||
| index.github.releases.createRelease = function(options, cb){ | ||
| cb(null,{"tag_name":"0.0.1","assets":[{}]}); | ||
| }; | ||
| index.github.releases.uploadAsset = function(cfg,cb){cb();}; | ||
| }; | ||
|
|
||
| describe("Publishes packages to GitHub Releases", function() { | ||
| describe("Throws an Error when node-pre-gyp-github is not configured properly", function() { | ||
|
|
||
| it("should throw an error when missing repository.url in package.json", function() { | ||
| reset_mocks(); | ||
| fs.readFileSync = function(){return '{}';}; | ||
| expect(function(){ index.publish(); }).to.throw("Missing repository.url in package.json"); | ||
| }); | ||
|
|
||
| it("should throw an error when a correctly formatted GitHub repository.url is not found in package.json", function() { | ||
| reset_mocks(); | ||
| fs.readFileSync = function(){return '{"repository": {"url":"bad_format_url"}}';}; | ||
| expect(function(){ index.publish(); }).to.throw("A correctly formatted GitHub repository.url was not found within package.json"); | ||
| }); | ||
|
|
||
| it("should throw an error when missing binary.host in package.json", function() { | ||
| reset_mocks(); | ||
| fs.readFileSync = function(){return '{"repository": {"url":"git+https://github.com/test/test.git"}}';}; | ||
| expect(function(){ index.publish(); }).to.throw("Missing binary.host in package.json"); | ||
| }); | ||
|
|
||
| it("should throw an error when binary.host does not begin with the correct url", function() { | ||
| reset_mocks(); | ||
| fs.readFileSync = function(){return '{"repository": {"url":"git+https://github.com/test/test.git"},"binary":{"host":"bad_format_binary"}}';}; | ||
| expect(function(){ index.publish(); }).to.throw(/^binary.host in package.json should begin with:/i); | ||
| }); | ||
|
|
||
| it("should throw an error when the NODE_PRE_GYP_GITHUB_TOKEN environment variable is not found", function() { | ||
| reset_mocks(); | ||
| process.env['NODE_PRE_GYP_GITHUB_TOKEN'] = ""; | ||
| expect(function(){ index.publish(); }).to.throw("NODE_PRE_GYP_GITHUB_TOKEN environment variable not found"); | ||
| }); | ||
|
|
||
| it("should throw an error when github.releases.listReleases returns an error", function() { | ||
| reset_mocks(); | ||
| index.github.releases.listReleases = function(options, cb){ | ||
| cb(new Error('listReleases error')); | ||
| }; | ||
| expect(function(){ index.publish(); }).to.throw('listReleases error'); | ||
| }); | ||
|
|
||
| it("should throw an error when github.releases.createRelease returns an error", function() { | ||
| var options = {'draft': true}; | ||
| reset_mocks(); | ||
| index.github.releases.listReleases = function(options, cb){ | ||
| cb(null,null); | ||
| }; | ||
| index.github.releases.createRelease = function(options, cb){ | ||
| cb(new Error('createRelease error')); | ||
| }; | ||
| expect(function(){ index.publish(options); }).to.throw('createRelease error'); | ||
| }); | ||
|
|
||
| it("should throw an error when the stage directory structure is missing", function() { | ||
| var options = {'draft': true}; | ||
| reset_mocks(); | ||
| fs.readdir = function(filename, cb) { | ||
| cb(new Error('readdir Error')); | ||
| }; | ||
| expect(function(){ index.publish(options); }).to.throw('readdir Error'); | ||
| }); | ||
|
|
||
| it("should throw an error when there are no files found within the stage directory", function() { | ||
| var options = {'draft': true}; | ||
| reset_mocks(); | ||
| fs.readdir = function(filename, cb) { | ||
| cb(null,[]); | ||
| }; | ||
| expect(function(){ index.publish(options); }).to.throw(/^No files found within the stage directory:/i); | ||
| }); | ||
|
|
||
| it("should throw an error when a staged file already exists in the current release", function() { | ||
| var options = {'draft': true}; | ||
| reset_mocks(); | ||
| fs.readdir = function(filename, cb) { | ||
| cb(null,["filename"]); | ||
| }; | ||
| index.github.releases.listReleases = function(options, cb){ | ||
| cb(null, [{"tag_name":"0.0.1","assets":[{"name":"filename"}]}]); | ||
| }; | ||
| expect(function(){ index.publish(options); }).to.throw(/^Staged file .* found but it already exists in release .*. If you would like to replace it, you must first manually delete it within GitHub./i); | ||
| }); | ||
|
|
||
| it("should throw an error when github.releases.uploadAsset returns an error", function() { | ||
| var options = {'draft': true}; | ||
| reset_mocks(); | ||
| fs.readdir = function(filename, cb) { | ||
| cb(null,["filename"]); | ||
| }; | ||
| index.github.releases.uploadAsset = function(cfg,cb){ | ||
| cb(new Error('uploadAsset error')); | ||
| }; | ||
| expect(function(){ index.publish(options); }).to.throw("uploadAsset error"); | ||
| }); | ||
|
|
||
| it("should publish without an error", function() { | ||
| var options = {'draft': true}; | ||
| reset_mocks(); | ||
| fs.readdir = function(filename, cb) { | ||
| cb(null,["filename"]); | ||
| }; | ||
| expect(function(){ index.publish(options); }).to.not.throw(); | ||
| }); | ||
|
|
||
| }); | ||
| }); |