Add spec stubs [WIP]

Author: Joshua Grosso

src/commands/push.js

@@ -10,13 +10,6 @@ import {
   verifyOutput
 } from '../helpers';
 
-/**
- * Note to future maintainers, I do not like this; at all. But at the moment this is the
- * best we got, inorder to parse the result from git core. Any slight change to the LFS output
- * in subsequent versions of CORE for LFS, will surely break this. Until we migrate off
- * git core dependency, we will have to regex the output. Godspeed.
- */
-
 const isValidLine = str => str !== '';
 
 const generatePushStats = (raw) => {

src/index.js

@@ -2,7 +2,10 @@ import initialize from './initialize';
 import register from './register';
 import unregister from './unregister';
 import { core } from './commands/lfsCommands';
-import { loadGitattributeFiltersFromRepo, repoHasLfs } from './helpers';
+import {
+  loadGitattributeFiltersFromRepo,
+  repoHasLfs
+} from './helpers';
 import checkout from './commands/checkout';
 import push from './commands/push';
 import track from './commands/track';

src/utils/spawnHelper.js

@@ -24,11 +24,28 @@ const buildSocketPath = () => tmp.dir()
     return path.join(prefix, cleanedPath, 'echo.sock');
   });
 
+/**
+ * Flow type definition:
+ *
+ * type BuildCredentialsCallbackProcess =
+ *   (
+ *     spawnedProcess: ChildProcess,
+ *     callback: (
+ *       passwordOnly: boolean,
+ *       callback: (usernamePrompt: boolean) =>
+ *                 (username: string, password: ?string, cancel: boolean) =>
+ *                 void
+ *       )
+ *     ),
+ *     reject: Error => Promise<void>
+ *   ) =>
+ *   (chunk: Buffer) =>
+ *   string;
+ */
 const buildCredentialsCallbackProcess = (spawnedProcess, callback, reject) => {
   let credentials = {};
   const credentialsCallback = needsUsername => (username, password, cancel) => {
     if (cancel) {
-      // we are done here
       spawnedProcess.destroy();
       return reject(new Error('LFS action cancelled'));
     }
@@ -42,22 +59,23 @@ const buildCredentialsCallbackProcess = (spawnedProcess, callback, reject) => {
     const output = chunk.toString();
 
     if (output.match(regex.USERNAME)) {
+      // We're caching the username in-memory in case the process asks for the username several
+      // times (for example, LFS re-prompts for credentials on every file).
       if (credentials.username) {
         spawnedProcess.write(credentials.username);
         spawnedProcess.write(EOL);
       } else {
-        // If we have a username we need to make sure to prompt for it
         callback(true, credentialsCallback(true));
       }
     } else if (output.match(regex.PASSWORD)) {
       if (credentials.password) {
         spawnedProcess.write(credentials.password);
         spawnedProcess.write(EOL);
       } else {
-        // no username so maybe ssh?
         callback(false, credentialsCallback(false));
       }
     }
+
     return output;
   };
 };
@@ -69,8 +87,7 @@ const buildSocket = (size, closeProcess, socketName, mainResolve, mainReject) =>
     let resolved = false;
 
     const closedOrEnded = () => {
-      // For some reason this fires twice so after
-      // the first fire let's move on
+      // Don't fire this callback if it's already been called.
       if (!resolved) {
         mainResolve({ stdout: Buffer.concat(bufferList) });
         resolved = true;
@@ -90,6 +107,7 @@ const buildSocket = (size, closeProcess, socketName, mainResolve, mainReject) =>
       });
       socket.on('error', mainReject);
     });
+
     socketServer.listen(socketName);
     socketServer.on('listening', () => {
       resolve(socketName);
@@ -200,3 +218,9 @@ const spawn = (command, opts = {}, callback) => new Promise(
   });
 
 export default spawn;
+
+export const __TESTING__ = { // eslint-disable-line no-underscore-dangle
+  buildCredentialsCallbackProcess,
+  buildSocket,
+  buildSocketPath
+};

test/tests/callbacks/initialize.check.js renamed to test/tests/callbacks/initialize.spec.js

@@ -0,0 +1,9 @@
+import {
+  todo
+} from '../../utils';
+
+describe('checkout', () => {
+  it('can checkout in the provided repo', todo);
+
+  it('responds appropriately on error', todo);
+});

test/tests/commands/checkout.spec.js

@@ -13,11 +13,11 @@ import {
   populateRemoteBranch
 } from '../../server/server';
 import {
-  fail
+  fail,
+  todo
 } from '../../utils';
 
 import {
-  BAD_CORE_RESPONSE,
   BAD_REGEX_PARSE_RESULT
 } from '../../../build/src/constants';
 import {
@@ -168,24 +168,5 @@ describe('Clone', () => {
     }
   });
 
-  it('should return an appropriate result on error', function () {
-    const {
-      NodeGitLFS
-    } = this;
-
-    return NodeGitLFS.LFS.clone(
-      'invalid',
-      testReposPath
-    )
-      .then((result) => {
-        expect(result.errno).to.equal(BAD_CORE_RESPONSE);
-        expect(result.stderr).to.equal(
-`fatal: repository 'invalid' does not exist
-Error(s) during clone:
-git clone failed: exit status 128
-`,
-        );
-        expect(result.success).to.be.false;
-      });
-  });
+  it('should return an appropriate result on error', todo);
 });

test/tests/commands/clone.spec.js

@@ -0,0 +1,39 @@
+import {
+  todo
+} from '../../utils';
+
+describe('lfsCommands', () => {
+  it('can run `git lfs checkout`', todo);
+
+  it('can run `git lfs clone`', todo);
+
+  it('can run `git lfs fetch`', todo);
+
+  it('can run `git lfs fsck`', todo);
+
+  it('can run any `git` command', todo);
+
+  it('can run `git lfs install`', todo);
+
+  it('can run `git lfs logs`', todo);
+
+  it('can run `git lfs ls-files`', todo);
+
+  it('can run `git lfs pointer`', todo);
+
+  it('can run `git lfs prune`', todo);
+
+  it('can run `git lfs pull`', todo);
+
+  it('can run `git lfs push`', todo);
+
+  it('can run `git lfs status`', todo);
+
+  it('can run `git lfs track`', todo);
+
+  it('can run `git lfs untrack`', todo);
+
+  it('can run `git lfs update`', todo);
+
+  it('can run `git lfs version`', todo);
+});

test/tests/commands/lfsCommands.spec.js

@@ -1,20 +1,11 @@
-import {
-  lfsTestRepoPath
-} from '../../constants';
 import {
   todo
 } from '../../utils';
 
-import ls from '../../../build/src/commands/ls';
-
 describe('ls-files', () => {
-  it('does generate ls response', function () {
-    const {
-      NodeGitLFS
-    } = this;
+  it('builds args from the provided options', todo);
+
+  it('can list LFS-tracked files in the provided repo', todo);
 
-    return NodeGitLFS.Repository.open(lfsTestRepoPath)
-      .then(repo => ls(repo, { long: true }))
-      .then(() => todo());
-  });
+  it('returns the correct response on error', todo);
 });

test/tests/commands/ls.spec.js

@@ -1,24 +1,11 @@
-import path from 'path';
-
-import {
-  lfsTestRepoPath
-} from '../../constants';
 import {
   todo
 } from '../../utils';
 
-import pointer from '../../../build/src/commands/pointer';
-
 describe('Pointer', () => {
-  it('does generate pointer response', function () {
-    const {
-      NodeGitLFS
-    } = this;
+  it('creates args from provided file and pointer paths', todo);
 
-    const packageJson = path.join(lfsTestRepoPath, 'package.json');
+  it('can build a pointer', todo);
 
-    return NodeGitLFS.Repository.open(lfsTestRepoPath)
-      .then(repo => pointer(repo, packageJson))
-      .then(() => todo());
-  });
+  it('responds appropriately on error', todo);
 });

test/tests/commands/pointer.spec.js

@@ -1,20 +1,9 @@
-import {
-  lfsTestRepoPath
-} from '../../constants';
 import {
   todo
 } from '../../utils';
 
-import prune from '../../../build/src/commands/prune';
-
 describe('Prune', () => {
-  it('does generate prune response', function () {
-    const {
-      NodeGitLFS
-    } = this;
+  it('can prune the provided repository', todo);
 
-    return NodeGitLFS.Repository.open(lfsTestRepoPath)
-      .then(repo => prune(repo))
-      .then(() => todo());
-  });
+  it('responds appropriately on error', todo);
 });

test/tests/commands/prune.spec.js

@@ -1,26 +1,9 @@
-import path from 'path';
-
-import {
-  lfsTestRepoPath
-} from '../../constants';
 import {
-  createDummyFile,
   todo
 } from '../../utils';
 
-import exec from '../../../build/src/utils/execHelper';
-
 describe('Push', () => {
-  it('should generate push response', function () {
-    const {
-      NodeGitLFS
-    } = this;
+  it('defaults to the current branch and its upstream', todo);
 
-    return createDummyFile(path.join(lfsTestRepoPath, 'test_file.txt'), 20)
-      .then(() => exec('git add test_file.txt', { cwd: lfsTestRepoPath }))
-      .then(() => exec('git commit -m "LFS: push unit test"', { cwd: lfsTestRepoPath }))
-      .then(() => NodeGitLFS.Repository.open(lfsTestRepoPath))
-      .then(repo => NodeGitLFS.LFS.push(repo, 'origin', 'test'))
-      .then(() => todo());
-  });
-}).timeout(5000);
+  it('responds appropriately on error', todo);
+});

test/tests/commands/push.spec.js

@@ -1,20 +1,11 @@
-import {
-  lfsTestRepoPath
-} from '../../constants';
 import {
   todo
 } from '../../utils';
 
-import track from '../../../build/src/commands/track';
-
 describe('Track', () => {
-  it('does generate track response', function () {
-    const {
-      NodeGitLFS
-    } = this;
+  it('requires globs to be provided', todo);
+
+  it('can track files', todo);
 
-    return NodeGitLFS.Repository.open(lfsTestRepoPath)
-      .then(repo => track(repo, ['*.png', '*.dmg']))
-      .then(() => todo());
-  });
+  it('responds appropriately on error', todo);
 });

test/tests/commands/track.spec.js

@@ -1,27 +1,11 @@
-import {
-  lfsTestRepoPath
-} from '../../constants';
 import {
   todo
 } from '../../utils';
 
-import track from '../../../build/src/commands/track';
-import untrack from '../../../build/src/commands/untrack';
-
 describe('Untrack', () => {
-  it('does generate untrack response', function () {
-    const {
-      NodeGitLFS
-    } = this;
+  it('requires globs to be provided', todo);
 
-    let repository;
+  it('can untrack currently-tracked files', todo);
 
-    return NodeGitLFS.Repository.open(lfsTestRepoPath)
-      .then((repo) => {
-        repository = repo;
-        return track(repo, ['*.png', '*.dmg', '*.txt', '*.a']);
-      })
-      .then(() => untrack(repository, ['*.dmg', '*.a']))
-      .then(() => todo());
-  });
+  it('responds appropriately on error', todo);
 });

test/tests/commands/untrack.spec.js

@@ -0,0 +1,27 @@
+import {
+  todo
+} from '../utils';
+
+describe('Constants', () => {
+  describe('Regexes', () => {
+    it('GIT', todo);
+
+    it('LFS', todo);
+
+    it('PASSWORD', todo);
+
+    it('SKIPPED_BYTES', todo);
+
+    it('SKIPPED_FILES', todo);
+
+    it('TOTAL_BYTES', todo);
+
+    it('TOTAL_FILES', todo);
+
+    it('TRACK', todo);
+
+    it('USERNAME', todo);
+
+    it('VERSION', todo);
+  });
+});

test/tests/constants.spec.js

@@ -54,7 +54,7 @@ describe('helpers', () => {
         repo
       } = this;
 
-      return track(repo, ['"*.md"', 'test.txt'])
+      return track(repo, ['*.md', 'test.txt'])
         .then(() => helpers.loadGitattributeFiltersFromRepo(repo))
         .then((result) => {
           expect(result).to.have.members(['*.md', 'test.txt']);