Working docker testing set-up with pureftpd

Author: sergi

.npmignore

@@ -3,5 +3,13 @@ coverage.html
 lib-cov
 reports
 .c9revisions
-test
+/test/
+/.vscode
+.nyc_output
+.editorconfig
+.eslintrc
+.travis.yml
+Dockerfile
+jsconfig.json
+README.md
 node_modules

.vscode/launch.json

@@ -0,0 +1,54 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Launch",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/lib/jsftp.js",
+            "stopOnEntry": false,
+            "args": [],
+            "cwd": "${workspaceRoot}",
+            "preLaunchTask": null,
+            "runtimeExecutable": null,
+            "runtimeArgs": [
+                "--nolazy"
+            ],
+            "env": {
+                "NODE_ENV": "development"
+            },
+            "console": "internalConsole",
+            "sourceMaps": false
+        },
+        {
+            "name": "Run mocha",
+            "type": "node",
+            "request": "launch",
+            "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+            "stopOnEntry": false,
+            "args": [
+                "-R",
+                "spec",
+                "-t",
+                "5000"
+            ],
+            "cwd": "${workspaceRoot}",
+            "runtimeExecutable": null,
+            "env": {
+                "NODE_ENV": "development"
+            }
+        },
+        {
+            "name": "Attach",
+            "type": "node",
+            "request": "attach",
+            "port": 5858,
+            "address": "localhost",
+            "restart": false,
+            "sourceMaps": false,
+            "outDir": null,
+            "localRoot": "${workspaceRoot}",
+            "remoteRoot": null
+        }
+    ]
+}

Dockerfile

@@ -0,0 +1,7 @@
+FROM node:alpine AS build-env-node
+ENV DEBUG=jsftp
+WORKDIR /jsftp
+COPY package.json .
+RUN npm install
+COPY ./lib/jsftp.js ./index.js
+COPY ./test/ ./test/

Makefile

@@ -17,9 +17,9 @@ conciseness. It doesn't get in the way and plays nice with streaming APIs.
 ## Starting it up
 
 ```javascript
-var JSFtp = require("jsftp");
+const jsftp = require("jsftp");
 
-var Ftp = new JSFtp({
+const Ftp = new jsftp({
   host: "myserver.com",
   port: 3331, // defaults to 21
   user: "user", // defaults to "anonymous"
@@ -37,8 +37,7 @@ callback, in the form of an object that contains two properties: `code`, which
 is the response code of the FTP operation, and `text`, which is the complete
 text of the response.
 
-Raw (or native) commands are accessible in the form `Ftp.raw(command, params,
-callback)`
+Raw (or native) commands are accessible in the form `Ftp.raw(command, params, callback)`
 
 Thus, a command like `QUIT` will be called like this:
 
@@ -104,7 +103,7 @@ const ftp = new Ffp({
 
       destination: {
         host,
-        port 
+        port
       }
     })
   }
@@ -161,9 +160,7 @@ file properties.
 
 ```javascript
 ftp.ls(".", (err, res) => {
-  res.forEach(file => {
-    console.log(file.name);
-  });
+  res.forEach(file => console.log(file.name));
 });
 ```
 
@@ -200,7 +197,9 @@ ftp.get("remote/path/file.txt", (err, socket) => {
   });
 
   socket.on("close", err => {
-    if (hadErr) console.error("There was an error retrieving the file.");
+    if (hadErr) {
+      console.error("There was an error retrieving the file.");
+    }
   });
 
   socket.resume();
@@ -306,19 +305,24 @@ Ftp.on("jsftp_debug", function(eventType, data) {
 
 ## Tests and Coverage
 
+JSFtp tests against ProFTPD by default. To accomplish that, it uses a Docker set-up, so you'll need Docker installed in your machine in order to run tests.
+
 To run tests and coverage reports:
 
     npm test
 
     ...
-    41 tests passing (6s)
-
-    |----------|----------|----------|----------|----------|----------------|
-    |File      |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
-    |----------|----------|----------|----------|----------|----------------|
-    |All files |       88 |    74.87 |    95.45 |       88 |                |
-    | jsftp.js |       88 |    74.87 |    95.45 |       88 |... 693,695,704 |
-    |----------|----------|----------|----------|----------|----------------|
+    43 passing (10s)
+
+    |-----------|----------|----------|----------|----------|----------------|
+    |File       |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
+    |-----------|----------|----------|----------|----------|----------------|
+    |All files  |    86.47 |    73.17 |    95.45 |    86.47 |                |
+    |jsftp      |      100 |      100 |      100 |      100 |                |
+    |  index.js |      100 |      100 |      100 |      100 |                |
+    |jsftp/lib  |    86.43 |    73.17 |    95.45 |    86.43 |                |
+    |  jsftp.js |    86.43 |    73.17 |    95.45 |    86.43 |... 722,724,733 |
+    |-----------|----------|----------|----------|----------|----------------|
 
 ## License
 

README.md

@@ -9,7 +9,7 @@
 
 "use strict";
 
-const createConnection = require("net").createConnection;
+const  createConnection = require("net").createConnection;
 const EventEmitter = require("events").EventEmitter;
 const inherits = require("util").inherits;
 const stream = require("stream");
@@ -39,18 +39,6 @@ const expectedMarks = {
 const RE_PASV = /([-\d]+,[-\d]+,[-\d]+,[-\d]+),([-\d]+),([-\d]+)/;
 const FTP_NEWLINE = /\r\n|\n/;
 
-function getPasvPort(text) {
-  const match = RE_PASV.exec(text);
-  if (!match) {
-    return null;
-  }
-
-  return {
-    host: match[1].replace(/,/g, "."),
-    port: (parseInt(match[2], 10) & 255) * 256 + (parseInt(match[3], 10) & 255)
-  };
-}
-
 function runCmd(name, ...params) {
   let callback = NOOP;
   let completeCmd = name + " ";
@@ -110,7 +98,9 @@ Ftp.prototype._createSocket = function(port, host, firstAction = NOOP) {
   this.resParser = new ResponseParser();
 
   this.authenticated = false;
-  this.socket = this.createSocket ? this.createSocket({port, host}, firstAction) : createConnection(port, host, firstAction);
+  this.socket = this.createSocket
+    ? this.createSocket({ port, host }, firstAction)
+    : createConnection(port, host, firstAction);
   this.socket.on("connect", this.reemit("connect"));
   this.socket.on("timeout", this.reemit("timeout"));
 
@@ -234,11 +224,28 @@ Ftp.prototype.parse = function(response, command) {
     err.code = response.code;
   }
 
-  command.callback(err, response);
   this.inProgress = false;
+  command.callback(err, response);
   this.nextCmd();
 };
 
+Ftp.prototype.getPasvPort = function(text) {
+  const match = RE_PASV.exec(text);
+  if (!match) {
+    return null;
+  }
+
+  let host = match[1].replace(/,/g, ".");
+  if (host === "127.0.0.1") {
+    host = this.host;
+  }
+
+  return {
+    host,
+    port: (parseInt(match[2], 10) & 255) * 256 + (parseInt(match[3], 10) & 255)
+  };
+};
+
 /**
  * Returns true if the current server has the requested feature.
  *
@@ -607,7 +614,6 @@ Ftp.prototype.getPutSocket = function(from, path, next) {
         }
         return next(new Error("Unexpected command " + res.text));
       }
-
     });
 
     callback.expectsMark = expectedMarks;
@@ -633,12 +639,14 @@ Ftp.prototype.getPasvSocket = function(callback = NOOP) {
       return callback(err);
     }
 
-    const options = getPasvPort(res.text);
+    const options = this.getPasvPort(res.text);
     if (!options) {
       return callback(new Error("Bad passive host/port combination"));
     }
 
-    const socket = (this._pasvSocket = this.createSocket ? this.createSocket(options) : createConnection(options));
+    const socket = (this._pasvSocket = this.createSocket
+      ? this.createSocket(options)
+      : createConnection(options));
     socket.setTimeout(this.timeout || TIMEOUT);
     socket.once("close", () => {
       this._pasvSocket = undefined;

lib/jsftp.js

@@ -1,17 +1,11 @@
 {
   "name": "jsftp",
   "id": "jsftp",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "A sane FTP client implementation for NodeJS",
-  "keywords": [
-    "ftp",
-    "protocol",
-    "files",
-    "server",
-    "client",
-    "async"
-  ],
-  "author": "Sergi Mansilla <[email protected]> (http://sergimansilla.com)",
+  "keywords": ["ftp", "protocol", "files", "server", "client", "async"],
+  "author":
+    "Sergi Mansilla <[email protected]> (https://sergimansilla.com)",
   "homepage": "https://github.com/sergi/jsftp",
   "repository": {
     "type": "git",
@@ -30,22 +24,20 @@
   },
   "devDependencies": {
     "concat-stream": "^1.6.0",
-    "eslint": "^4.12.1",
-    "eslint-plugin-security": "^1.4.0",
-    "ftp-test-server": "0.0.2",
-    "ftpd": "github:sstur/nodeftpd#0d299f7",
     "mocha": "^4.0.1",
     "nyc": "^11.4.0",
     "rimraf": "^2.6.1",
     "sinon": "^4.1.2"
   },
-  "main": "lib/jsftp.js",
+  "main": "index.js",
   "engines": {
     "node": ">=6"
   },
   "scripts": {
-    "test": "nyc mocha -R spec -t 5000",
-    "clean": "rm -rf reports"
+    "test": "make -f test/Makefile test-pureftpd",
+    "run-mocha": "nyc mocha -R spec -t 5000",
+    "clean": "rm -rf reports",
+    "check-format": "prettier --list-different ./lib/**"
   },
   "license": "MIT"
 }

package.json

@@ -0,0 +1,16 @@
+# Foolproof way to always have ROOT_DIR refer to this very folder
+ROOT_DIR:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
+
+build-pureftpd:
+	docker build --rm -t pure-ftp-demo $(ROOT_DIR)/pureftpd
+
+test-pureftpd: kill-pureftpd
+	docker run -d --name pureftpd_server -p 21:21 -p 30000-30009:30000-30009 -e "PUBLICHOST=localhost" -e "ADDED_FLAGS=-d -d" pure-ftp-demo
+	docker exec -it pureftpd_server sh -c "(echo test; echo test) | pure-pw useradd bob -f /etc/pure-ftpd/passwd/pureftpd.passwd -m -u ftpuser -d /home/ftpusers/bob"
+	npm run run-mocha
+
+kill-pureftpd:
+	-docker kill pureftpd_server
+	-docker rm pureftpd_server
+
+.PHONY: build-pureftpd test-pureftpd kill-pureftpd

test/Makefile

@@ -0,0 +1,33 @@
+version: '3'
+
+services:
+  pureftpd:
+    container_name: ftpd_server
+    environment:
+      - PUBLICHOST=localhost
+      - ADDED_FLAGS=-d -d
+    build: ./pureftpd
+    ports:
+      - "21:21"
+      - "30000-30009:30000-30009"
+    # expose:
+    #   - "21"
+    #   - "30000-30009"
+  vsftpd:
+    container_name: vsftpd_server
+    environment:
+      - FTP_USER=bob
+      - FTP_PASS=test
+      - PASV_MIN_PORT=21100
+      - PASV_MAX_PORT=21110 
+    build: ./vsftpd
+    ports:
+      - "7001:21"
+      - "21100-21110:21100-21110"
+  # integration-test:
+  #   build: ..
+  #   environment:
+  #     - DEBUG=jsftp
+  #   command: npm run test
+  #   links:
+  #     - pureftpd