Skip to content

Commit

Permalink
Fix GitHub tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@harveysanders
harveysanders committed Jan 30, 2024
1 parent 51195fa commit 7c5aa13
Show file tree
Hide file tree
Showing 3 changed files with 91 additions and 70 deletions.
10 changes: 10 additions & 0 deletions controller/github.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,12 @@ function promptForUserInfo() {

module.exports.promptForUserInfo = promptForUserInfo;

/**
*
* @param {object} auth
* @param {string} auth.token GitHub Personal Access Token
* @returns {Promise<{token: string}>}
*/
function writeAuth(auth) {
deleteAuth();
console.log(clc.yellow('Writing auth. . .'));
Expand Down Expand Up @@ -333,6 +339,10 @@ function deleteUser() {

module.exports.deleteUser = deleteUser;

// TODO: Should be async
/**
* Deletes the auth and user files.
*/
function deleteUserInfo() {
console.log(clc.red('Deleting files. . .'));
deleteAuth();
Expand Down
20 changes: 15 additions & 5 deletions test/helpers/fakeHelpers.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
const fs = require('fs');
const { dummyUser, dummyAuth, dummyGistGood, dummyTestPass, dummyTestFail } = require('./dummyData');
const {
dummyUser,
dummyAuth,
dummyGistGood,
dummyTestPass,
dummyTestFail
} = require('./dummyData');

module.exports.home = () => './test/files';

Expand Down Expand Up @@ -29,12 +34,15 @@ module.exports.deleteGistHelper = () => `echo ${dummyUser}`;

module.exports.readGistHelper = () => `echo ${dummyUser}`;

module.exports.downloadProject = (url, token, directory) => `mkdir ${directory} ${directory}/.git ${directory}/.svn ${directory}/.master ${directory}/test`;
module.exports.downloadProject = (url, token, directory) =>
`mkdir ${directory} ${directory}/.git ${directory}/.svn ${directory}/.master ${directory}/test`;

module.exports.downloadProjectTests = (url, token, directory) => `mkdir ${directory}/test ${directory}/node_modules`;
module.exports.downloadProjectTests = (url, token, directory) =>
`mkdir ${directory}/test ${directory}/node_modules`;

// package.json must be parse-able, so echoing an empty object into it
module.exports.downloadProjectPackage = (url, token, directory) => `echo {} > ${directory}/package.json`;
module.exports.downloadProjectPackage = (url, token, directory) =>
`echo {} > ${directory}/package.json`;

module.exports.makeTestPass = () => `echo '${dummyTestPass}'`;

Expand All @@ -43,3 +51,5 @@ module.exports.makeTestFail = () => `echo '${dummyTestFail}'`;
module.exports.reportPass = () => Promise.resolve(JSON.parse(dummyTestPass));

module.exports.reportFail = () => Promise.resolve(JSON.parse(dummyTestFail));

module.exports.getGithubID = () => `echo '{ "id": ${dummyUser.id} }'`;
131 changes: 66 additions & 65 deletions test/test-github.js
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,9 @@
/* global describe it expect before beforeEach afterEach */
require('mocha');
require('should');
const clc = require('cli-color');
const _ = require('lodash');
const util = require('util');

const fs = require('fs-extra');
const sinon = require('sinon');
const prompt = require('prompt');
const rimraf = require('rimraf');
const process = require('process');
const fsJson = require('fs-json')();
const expect = require('chai').expect;
const bddStdin = require('bdd-stdin');
const proxyquire = require('proxyquire');
Expand Down Expand Up @@ -52,12 +46,12 @@ describe('github', function () {
bddStdin('Username\nPassword\n');
github.promptForUserInfo().then(function (user) {
expect(user.username).to.equal('Username');
expect(user.password).to.equal('Password');
expect(user.token).to.equal('Password');
});
bddStdin('livrush\n********\n');
github.promptForUserInfo().then(function (user) {
expect(user.username).to.equal('livrush');
expect(user.password).to.equal('********');
expect(user.token).to.equal('********');
done();
});
});
Expand All @@ -66,7 +60,7 @@ describe('github', function () {
describe('#authExists()', function () {
it('should return true if directory exists', function (done) {
expect(github.authExists()).to.be.false;
fs.writeFileSync(authFilePath, dummyAuth);
fs.writeFileSync(authFilePath, JSON.stringify(dummyAuth), 'utf-8');
expect(github.authExists()).to.be.true;
fs.unlinkSync(authFilePath);
expect(github.authExists()).to.be.false;
Expand All @@ -77,7 +71,7 @@ describe('github', function () {
describe('#userExists()', function () {
it('should return true if directory exists', function (done) {
expect(github.userExists()).to.be.false;
fs.writeFileSync(userFilePath, dummyAuth);
fs.writeFileSync(userFilePath, JSON.stringify(dummyAuth), 'utf-8');
expect(github.userExists()).to.be.true;
fs.unlinkSync(userFilePath);
expect(github.userExists()).to.be.false;
Expand All @@ -86,17 +80,18 @@ describe('github', function () {
});

describe('#userInfoExists()', function () {
beforeEach(function () {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
beforeEach(async function () {
await github.writeAuth(dummyAuth);
await github.writeUser(dummyAuth);
});
afterEach(function (done) {
rimraf(applicationDirectory, function () {
done();
});
});
it('should return true if directory exists', function (done) {
expect(github.userInfoExists()).to.be.true;
expect(github.userInfoExists(), 'user info directory should exist').to.be
.true;
done();
});
});
Expand All @@ -115,9 +110,10 @@ describe('github', function () {
});
it('should write correct information', function (done) {
github.writeAuth(dummyAuth);
let auth = fs.readFileSync(authFilePath);
let auth = fs.readFileSync(authFilePath, 'utf-8');
auth = JSON.parse(auth);
expect(auth).to.eql(dummyAuth);
// writeAuth() only writes token
expect(auth).to.eql({ token: dummyAuth.token });
done();
});
});
Expand All @@ -128,28 +124,31 @@ describe('github', function () {
done();
});
});
it('should write user file', function (done) {
expect(fs.existsSync(userFilePath)).to.be.false;
github.writeUser(dummyUser);
expect(fs.existsSync(userFilePath)).to.be.true;
done();

it('should write user file', async function () {
expect(
fs.existsSync(userFilePath),
'"user" file should not initially exist'
).to.be.false;
await github.writeUser(dummyAuth);
expect(fs.existsSync(userFilePath), '"user" file should exist').to.be
.true;
});
it('should write correct information', function (done) {
github.writeUser(dummyUser);
let user = fs.readFileSync(userFilePath);

it('should write correct information', async function () {
await github.writeUser(dummyAuth);
let user = fs.readFileSync(userFilePath, 'utf-8');
user = JSON.parse(user);
expect(user).to.eql(dummyUser);
done();
expect(user).to.eql({ username: dummyUser.login, id: dummyUser.id });
});
});

describe('#grabLocalUserID()', function () {
it('should return user id if file exists', function (done) {
github.writeUser(dummyUser);
it('should return user id if file exists', async function () {
await github.writeUser(dummyAuth);
const placeholder = dummyUser.id;
const result = github.grabLocalUserID();
expect(result).to.equal(placeholder);
done();
});

it("should throw error if file doesn't exist", function (done) {
Expand All @@ -163,12 +162,11 @@ describe('github', function () {
});

describe('#grabLocalLogin()', function () {
it('should return login if file exists', function (done) {
github.writeUser(dummyUser);
it('should return login if file exists', async function () {
await github.writeUser(dummyAuth);
const placeholder = dummyUser.login;
const result = github.grabLocalLogin();
expect(result).to.equal(placeholder);
done();
});

it("should throw error if file doesn't exist", function (done) {
Expand All @@ -181,13 +179,15 @@ describe('github', function () {
});
});

describe('#grabLocalAuthID()', function () {
it('should return id if file exists', function (done) {
github.writeAuth(dummyAuth);
// Current implementation of writeAuth only writes token.
// So grabLocalAuthID always returns undefined. grabLocalAuthID is only used in
// github.deleteGithubToken which may not work with current GitHub API.
describe.skip('#grabLocalAuthID()', function () {
it('should return id if file exists', async function () {
await github.writeAuth(dummyAuth);
const placeholder = dummyAuth.id;
const result = github.grabLocalAuthID();
expect(result).to.equal(placeholder);
done();
});

it("should throw error if file doesn't exist", function (done) {
Expand Down Expand Up @@ -224,18 +224,16 @@ describe('github', function () {
expect(github.getCredentials()).to.be.an.instanceof(Promise);
});

it('should resolve credentials when they exist', function (done) {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
it('should resolve credentials when they exist', async function () {
await github.writeAuth(dummyAuth);
await github.writeUser(dummyAuth);
expect(github.userInfoExists()).to.be.true;
github.getCredentials().then(function (user) {
expect(user.login).to.equal('livrush');
expect(user.id).to.equal(23201987);
expect(user.token).to.equal('fauxToken');
fs.unlinkSync(authFilePath);
fs.unlinkSync(userFilePath);
done();
});
const user = await github.getCredentials();
expect(user.login).to.equal('livrush');
expect(user.id).to.equal(23201987);
expect(user.token).to.equal('fauxToken');
fs.unlinkSync(authFilePath);
fs.unlinkSync(userFilePath);
});

// it('should call authorizeUser when no credentials exist', function (done) {
Expand Down Expand Up @@ -267,14 +265,12 @@ describe('github', function () {
expect(github.getOrObtainAuth()).to.be.an.instanceof(Promise);
});

it('should resolve auth object', function (done) {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
github.getOrObtainAuth().then(function (res) {
expect(res).to.eql(dummyAuth);
github.deleteUserInfo();
done();
});
it('should resolve auth object', async function () {
await github.writeAuth(dummyAuth);
await github.writeUser(dummyAuth);
const res = await github.getOrObtainAuth();
expect(res).to.eql({ token: dummyAuth.token });
await github.deleteUserInfo();
});
});

Expand All @@ -285,7 +281,7 @@ describe('github', function () {

it('should resolve user object', function (done) {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
github.writeUser(dummyAuth);
github.getOrCreateClient().then(function (res) {
expect(res).to.eql(dummyUser);
github.deleteUserInfo();
Expand Down Expand Up @@ -349,15 +345,15 @@ describe('github', function () {
bddStdin('livrush\nPassword\n');
github.authorizeUser().then(function (user) {
expect(user.login).to.equal('livrush');
expect(user.token).to.equal('fauxToken');
expect(user.token).to.equal('Password');
done();
});
});
});

describe('#deleteAuth()', function () {
it('should delete auth file', function () {
fs.createFileSync(authFilePath, dummyAuth);
fs.createFileSync(authFilePath);
expect(fs.existsSync(authFilePath)).to.be.true;
github.deleteAuth();
expect(fs.existsSync(authFilePath)).to.be.false;
Expand All @@ -366,17 +362,22 @@ describe('github', function () {

describe('#deleteUser()', function () {
it('should delete user file', function () {
fs.createFileSync(userFilePath, dummyUser);
fs.createFileSync(userFilePath);
expect(fs.existsSync(userFilePath)).to.be.true;
github.deleteUser();
expect(fs.existsSync(userFilePath)).to.be.false;
});
});

describe('#deleteUserInfo()', function () {
beforeEach(function () {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
beforeEach(async function () {
try {
await github.writeAuth(dummyAuth);

await github.writeUser(dummyAuth);
} catch (error) {
console.error(error);
}
});

it('should return true if directory exists', function (done) {
Expand All @@ -390,7 +391,7 @@ describe('github', function () {
describe('#deleteToken()', function () {
beforeEach(function () {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
github.writeUser(dummyAuth);
});

it('should return a promise', function () {
Expand All @@ -409,7 +410,7 @@ describe('github', function () {
describe('#deauthorizeUser()', function () {
beforeEach(function () {
github.writeAuth(dummyAuth);
github.writeUser(dummyUser);
github.writeUser(dummyAuth);
});

it('should return a promise', function () {
Expand Down

0 comments on commit 7c5aa13

Please sign in to comment.