Compare commits
55 Commits
update-doc
...
v3.0.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
8e34e4c71a | ||
|
|
0afd578683 | ||
|
|
46b0d52ff2 | ||
|
|
185e473edc | ||
|
|
92a323f3dd | ||
|
|
f67e487306 | ||
|
|
2716123da7 | ||
|
|
ef207f60c1 | ||
|
|
4d8cf42ad0 | ||
|
|
50c6b92d12 | ||
|
|
a2103e5a3c | ||
|
|
2302b749fa | ||
|
|
27b43d702b | ||
|
|
fae003e644 | ||
|
|
a51678ae70 | ||
|
|
bc26886a0d | ||
|
|
c9b4371579 | ||
|
|
95471bdd15 | ||
|
|
5a36a6685d | ||
|
|
90a7419661 | ||
|
|
29cb035f66 | ||
|
|
66fc66ed80 | ||
|
|
c970a42132 | ||
|
|
30ae54a952 | ||
|
|
91be338ebd | ||
|
|
2a5013447c | ||
|
|
1f15af0fb6 | ||
|
|
1cf1f750f4 | ||
|
|
442490d713 | ||
|
|
58b9ba27d9 | ||
|
|
87a2138cb3 | ||
|
|
9fd423c745 | ||
|
|
363839ec8f | ||
|
|
d9fc0c9cac | ||
|
|
b0463d65b6 | ||
|
|
47b2cc0593 | ||
|
|
e5f24f991d | ||
|
|
87f3ae79a1 | ||
|
|
3a7b3d4570 | ||
|
|
dc040eaabd | ||
|
|
fecec961e1 | ||
|
|
5ff677ce42 | ||
|
|
cc0f2a5cd3 | ||
|
|
414433a56e | ||
|
|
a794f1e5b3 | ||
|
|
1b5d22a3ca | ||
|
|
4205caf7ac | ||
|
|
a468d4ffd0 | ||
|
|
40b08893ac | ||
|
|
8a2454ceea | ||
|
|
0c7cc4fe6e | ||
|
|
6ea6baceb0 | ||
|
|
b07e0189ee | ||
|
|
ec30a5a4f3 | ||
|
|
6020409979 |
@@ -1,140 +1,103 @@
|
||||
version: 2
|
||||
|
||||
create-cache-file: &create-cache-file
|
||||
run:
|
||||
name: Setup cache
|
||||
command: echo "$NODE_VERSION" > _cache_node_version
|
||||
|
||||
package-json-cache: &package-json-cache
|
||||
key: npm-install-{{ checksum "_cache_node_version" }}-{{ checksum "package-lock.json" }}
|
||||
|
||||
base-build: &base-build
|
||||
steps:
|
||||
- checkout
|
||||
- <<: *create-cache-file
|
||||
- restore_cache:
|
||||
<<: *package-json-cache
|
||||
- run:
|
||||
name: Install
|
||||
command: npm install
|
||||
- save_cache:
|
||||
<<: *package-json-cache
|
||||
paths:
|
||||
- node_modules
|
||||
- run:
|
||||
name: Lint
|
||||
command: npm run verify:js
|
||||
- run:
|
||||
name: Test
|
||||
command: npm run test:once
|
||||
|
||||
jobs:
|
||||
build_node_8:
|
||||
test_node_10:
|
||||
docker:
|
||||
- image: circleci/node:8
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
key: npm-install-node-8-{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Install
|
||||
command: npm install
|
||||
- save_cache:
|
||||
key: npm-install-node-8-{{ checksum "package.json" }}
|
||||
paths:
|
||||
- node_modules
|
||||
|
||||
build_node_6:
|
||||
docker:
|
||||
- image: circleci/node:6
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
key: npm-install-node-6-{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Install
|
||||
command: npm install
|
||||
- save_cache:
|
||||
key: npm-install-node-6-{{ checksum "package.json" }}
|
||||
paths:
|
||||
- node_modules
|
||||
|
||||
lint:
|
||||
docker:
|
||||
- image: circleci/node:8
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
key: npm-install-node-8-{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Lint
|
||||
command: npm run verify:js
|
||||
- image: circleci/node:10
|
||||
environment:
|
||||
- NODE_VERSION: 10
|
||||
<<: *base-build
|
||||
|
||||
test_node_8:
|
||||
docker:
|
||||
- image: circleci/node:8
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
key: npm-install-node-8-{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Test Node 8
|
||||
command: npm run test:coverage
|
||||
when: always
|
||||
- store_test_results:
|
||||
path: reports
|
||||
- store_artifacts:
|
||||
path: reports/coverage
|
||||
prefix: coverage
|
||||
environment:
|
||||
- NODE_VERSION: 8
|
||||
<<: *base-build
|
||||
|
||||
test_node_6:
|
||||
docker:
|
||||
- image: circleci/node:6
|
||||
steps:
|
||||
- checkout
|
||||
- restore_cache:
|
||||
key: npm-install-node-6-{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Test Node 6
|
||||
command: npm run test:coverage
|
||||
when: always
|
||||
- store_test_results:
|
||||
path: reports
|
||||
- store_artifacts:
|
||||
path: reports/coverage
|
||||
prefix: coverage
|
||||
environment:
|
||||
- NODE_VERSION: 6
|
||||
<<: *base-build
|
||||
|
||||
release:
|
||||
docker:
|
||||
- image: circleci/node:8
|
||||
environment:
|
||||
- NODE_VERSION: 8
|
||||
steps:
|
||||
- checkout
|
||||
- <<: *create-cache-file
|
||||
- restore_cache:
|
||||
key: npm-install-node-6-{{ checksum "package.json" }}
|
||||
- run:
|
||||
name: Update NPM
|
||||
command: |
|
||||
npm install npm@5
|
||||
npm install semantic-release@11
|
||||
<<: *package-json-cache
|
||||
- deploy:
|
||||
name: Semantic Release
|
||||
command: |
|
||||
npm run semantic-release || true
|
||||
npm run semantic-release
|
||||
|
||||
workflows:
|
||||
version: 2
|
||||
test_and_tag:
|
||||
jobs:
|
||||
- build_node_8:
|
||||
- test_node_10:
|
||||
filters:
|
||||
branches:
|
||||
only: master
|
||||
- build_node_6:
|
||||
filters:
|
||||
branches:
|
||||
only: master
|
||||
- lint:
|
||||
requires:
|
||||
- build_node_8
|
||||
- test_node_6:
|
||||
requires:
|
||||
- build_node_6
|
||||
- test_node_8:
|
||||
requires:
|
||||
- build_node_8
|
||||
filters:
|
||||
branches:
|
||||
only: master
|
||||
- test_node_6:
|
||||
filters:
|
||||
branches:
|
||||
only: master
|
||||
- release:
|
||||
requires:
|
||||
- lint
|
||||
- test_node_6
|
||||
- test_node_8
|
||||
- test_node_10
|
||||
|
||||
build_and_test:
|
||||
jobs:
|
||||
- build_node_8:
|
||||
- test_node_10:
|
||||
filters:
|
||||
branches:
|
||||
ignore: master
|
||||
- build_node_6:
|
||||
filters:
|
||||
branches:
|
||||
ignore: master
|
||||
- lint:
|
||||
requires:
|
||||
- build_node_8
|
||||
- test_node_6:
|
||||
requires:
|
||||
- build_node_6
|
||||
- test_node_8:
|
||||
requires:
|
||||
- build_node_8
|
||||
filters:
|
||||
branches:
|
||||
ignore: master
|
||||
- test_node_6:
|
||||
filters:
|
||||
branches:
|
||||
ignore: master
|
||||
24
.nycrc
24
.nycrc
@@ -1,24 +0,0 @@
|
||||
{
|
||||
"check-coverage": true,
|
||||
"per-file": false,
|
||||
"lines": 90,
|
||||
"statements": 90,
|
||||
"functions": 85,
|
||||
"branches": 75,
|
||||
"include": [
|
||||
"src/**/*.js"
|
||||
],
|
||||
"exclude": [
|
||||
"test/**/*.spec.js"
|
||||
],
|
||||
"reporter": [
|
||||
"lcovonly",
|
||||
"html",
|
||||
"text",
|
||||
"cobertura",
|
||||
"json"
|
||||
],
|
||||
"cache": true,
|
||||
"all": true,
|
||||
"report-dir": "./reports/coverage/"
|
||||
}
|
||||
221
CONTRIBUTING.md
221
CONTRIBUTING.md
@@ -1,211 +1,20 @@
|
||||
<!--[CN_HEADING]-->
|
||||
# Contributing
|
||||
<p align="center">
|
||||
<a href="https://github.com/trs/ftp-srv">
|
||||
<img alt="ftp-srv" src="logo.png" width="400px" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
Welcome! This document explains how you can contribute to making **ftp-srv** even better.
|
||||
<h1 align="center">
|
||||
Contributing Guide
|
||||
</h1>
|
||||
|
||||
## Welcome
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_GETTING_STARTED]-->
|
||||
# Getting Started
|
||||
|
||||
## Installation
|
||||
|
||||
```
|
||||
git clone <this repo>
|
||||
npm install -g commitizen
|
||||
npm install -g semantic-release-cli
|
||||
npm install
|
||||
```
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[RM_DIR_STRUCTURE]-->
|
||||
## Directory Structure
|
||||
|
||||
Code is organised into modules which contain one-or-more components. This a great way to ensure maintainable code by encapsulation of behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:
|
||||
```
|
||||
ftp-srv/
|
||||
├──config/ * configuration files live here (e.g. eslint, verify, testUnit)
|
||||
│
|
||||
├──src/ * source code files should be here
|
||||
│
|
||||
├──dist/ * production-build code should live here
|
||||
│
|
||||
├──reports/ * test reports appear here
|
||||
│
|
||||
├──test/ * unit test specifications live here
|
||||
│
|
||||
├──confit.yml * the project config file generated by 'yo confit'
|
||||
├──CONTRIBUTING.md * how to contribute to the project
|
||||
├──README.md * this file
|
||||
└──package.json * NPM package description file
|
||||
```
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_GITFLOW_PROCESS]-->
|
||||
# GitFlow Development Process
|
||||
|
||||
This project uses the [GitHub Flow](https://guides.github.com/introduction/flow/index.html) workflow.
|
||||
|
||||
## Create a branch
|
||||
When you're working on a project, you're going to have a bunch of different features or ideas in progress at any given time – some of which are ready to go, and others which are not. Branching exists to help you manage this workflow.
|
||||
|
||||
When you create a branch in your project, you're creating an environment where you can try out new ideas. Changes you make on a branch don't affect the `master` branch, so you're free to experiment and commit changes, safe in the knowledge that your branch won't be merged until it's ready to be reviewed by someone you're collaborating with.
|
||||
|
||||
###ProTip
|
||||
|
||||
Branching is a core concept in Git, and the entire GitHub Flow is based upon it. There's only one rule: anything in the `master` branch is always deployable.
|
||||
|
||||
Because of this, it's extremely important that your new branch is created off of `master` when working on a feature or a fix. Your branch name should be descriptive (e.g., `refactor-authentication`, `user-content-cache-key`, `make-retina-avatars`), so that others can see what is being worked on.
|
||||
|
||||
## Add commits
|
||||
Once your branch has been created, it's time to start making changes. Whenever you add, edit, or delete a file, you're making a commit, and adding them to your branch. This process of adding commits keeps track of your progress as you work on a feature branch.
|
||||
|
||||
Commits also create a transparent history of your work that others can follow to understand what you've done and why. Each commit has an associated commit message, which is a description explaining why a particular change was made. Furthermore, each commit is considered a separate unit of change. This lets you roll back changes if a bug is found, or if you decide to head in a different direction.
|
||||
|
||||
###ProTip
|
||||
|
||||
Commit messages are important, especially since Git tracks your changes and then displays them as commits once they're pushed to the server. By writing clear commit messages, you can make it easier for other people to follow along and provide feedback.
|
||||
|
||||
## Open a pull request
|
||||
|
||||
Pull Requests initiate discussion about your commits. Because they're tightly integrated with the underlying Git repository, anyone can see exactly what changes would be merged if they accept your request.
|
||||
|
||||
You can open a Pull Request at any point during the development process: when you have little or no code but want to share some screenshots or general ideas, when you're stuck and need help or advice, or when you're ready for someone to review your work. By using GitHub's @mention system in your Pull Request message, you can ask for feedback from specific people or teams, whether they're down the hall or ten time zones away.
|
||||
|
||||
###ProTip
|
||||
|
||||
Pull Requests are useful for contributing to open source projects and for managing changes to shared repositories. If you're using a Fork & Pull Model, Pull Requests provide a way to notify project maintainers about the changes you'd like them to consider. If you're using a Shared Repository Model, Pull Requests help start code review and conversation about proposed changes before they're merged into the `master` branch.
|
||||
|
||||
## Discuss and review your code
|
||||
Once a Pull Request has been opened, the person or team reviewing your changes may have questions or comments. Perhaps the coding style doesn't match project guidelines, the change is missing unit tests, or maybe everything looks great and props are in order. Pull Requests are designed to encourage and capture this type of conversation.
|
||||
|
||||
You can also continue to push to your branch in light of discussion and feedback about your commits. If someone comments that you forgot to do something or if there is a bug in the code, you can fix it in your branch and push up the change. GitHub will show your new commits and any additional feedback you may receive in the unified Pull Request view.
|
||||
|
||||
###ProTip
|
||||
|
||||
Pull Request comments are written in Markdown, so you can embed images and emoji, use pre-formatted text blocks, and other lightweight formatting.
|
||||
|
||||
## Merge to `master`
|
||||
|
||||
Once your PR has passed any the integration tests and received approval to merge, it is time to merge your code into the `master` branch.
|
||||
|
||||
Once merged, Pull Requests preserve a record of the historical changes to your code. Because they're searchable, they let anyone go back in time to understand why and how a decision was made.
|
||||
|
||||
###ProTip
|
||||
|
||||
By incorporating certain keywords into the text of your Pull Request, you can associate issues with code. When your Pull Request is merged, the related issues are also closed. For example, entering the phrase Closes #32 would close issue number 32 in the repository. For more information, check out our help article.
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_BUILD_TASKS]-->
|
||||
## Build Tasks
|
||||
|
||||
Command | Description
|
||||
:------ | :----------
|
||||
<pre>npm run build</pre> | Generate production build into [dist/](dist/) folder
|
||||
<pre>npm run dev</pre> | Run project in development mode (verify code, and re-verify when code is changed)
|
||||
<pre>npm start</pre> | Alias for `npm run dev` task
|
||||
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_TEST_TASKS]-->
|
||||
## Test Tasks
|
||||
|
||||
Command | Description
|
||||
:------ | :----------
|
||||
<pre>npm test</pre> | Alias for `npm run test:unit` task
|
||||
<pre>npm run test:coverage</pre> | Run instrumented unit tests then verify coverage meets defined thresholds<ul><li>Returns non-zero exit code when coverage does not meet thresholds (as defined in istanbul.js)</li></ul>
|
||||
<pre>npm run test:unit</pre> | Run unit tests whenever JS source or tests change<ul><li>Uses Mocha</li><li>Code coverage</li><li>Runs continuously (best to run in a separate window)</li></ul>
|
||||
<pre>npm run test:unit:once</pre> | Run unit tests once<ul><li>Uses Mocha</li><li>Code coverage</li></ul>
|
||||
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_VERIFY_TASKS]-->
|
||||
## Verification (Linting) Tasks
|
||||
|
||||
Command | Description
|
||||
:------ | :----------
|
||||
<pre>npm run verify</pre> | Verify code style and syntax<ul><li>Verifies source *and test code* aginst customisable rules (unlike Webpack loaders)</li></ul>
|
||||
<pre>npm run verify:js</pre> | Verify Javascript code style and syntax
|
||||
<pre>npm run verify:js:fix</pre> | Verify Javascript code style and syntax and fix any errors that can be fixed automatically
|
||||
<pre>npm run verify:js:watch</pre> | Verify Javascript code style and syntax and watch files for changes
|
||||
<pre>npm run verify:watch</pre> | Runs verify task whenever JS or CSS code is changed
|
||||
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_COMMIT_TASKS]-->
|
||||
## Commit Tasks
|
||||
|
||||
Command | Description
|
||||
:------ | :----------
|
||||
<pre>git status</pre> | Lists the current branch and the status of changed files
|
||||
<pre>git log</pre> | Displays the commit log (press Q to quit viewing)
|
||||
<pre>git add .</pre> | Stages all modified & untracked files, ready to be committed
|
||||
<pre>git cz</pre> | Commit changes to local repository using Commitizen.<ul><li>Asks questions about the change to generate a valid conventional commit message</li><li>Can be customised by modifying [config/release/commitMessageConfig.js](config/release/commitMessageConfig.js)</li></ul>
|
||||
<pre>git push</pre> | Push local repository changes to remote repository
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_DOCUMENTATION_TASKS]-->
|
||||
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
<!--[CN_RELEASE_TASKS]-->
|
||||
## Release Tasks
|
||||
|
||||
Command | Description
|
||||
:------ | :----------
|
||||
<pre>npm run commitmsg</pre> | Git commit message hook that validates the commit message conforms to your commit message conventions.
|
||||
<pre>npm run pre-release</pre> | Verify code, run unit tests, check test coverage, build software. This task is designed to be run before
|
||||
the `semantic-release` task.
|
||||
<ul><li>Run `semantic-release-cli setup` once you have a remote repository. See https://github.com/semantic-release/cli for details.</li><li>Semantic-release integrates with Travis CI (or similar tools) to generate release notes
|
||||
for each release (which appears in the "Releases" section in GitHub) and
|
||||
publishes the package to NPM (when all the tests are successful) with a semantic version number.
|
||||
</li></ul>
|
||||
<pre>npm run prepush</pre> | Git pre-push hook that verifies code and checks unit test coverage meet minimum thresholds.
|
||||
<pre>npm run upload-coverage</pre> | Uploads code-coverage metrics to Coveralls.io<ul><li>Setup - https://coveralls.zendesk.com/hc/en-us/articles/201347419-Coveralls-currently-supports</li><li>Define an environment variable called COVERALLS_REPO_TOKEN in your build environment with the repo token from https://coveralls.io/github/<repo-name>/settings</li><li>In your CI configuration (e.g. `travis.yml`), call `npm run upload-coverage` if the build is successful.</li></ul>
|
||||
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
|
||||
<!--[CN_CHANGING_BUILD_TOOL_CONFIG]-->
|
||||
## Changing build-tool configuration
|
||||
|
||||
There are 3 ways you can change the build-tool configuration for this project:
|
||||
|
||||
1. BEST: Modify the Confit configuration file ([confit.yml](confit.yml)) by hand, then re-run `yo confit` and tell it to use the existing configuration.
|
||||
1. OK: Re-run `yo confit` and provide new answers to the questions. **Confit will attempt to overwrite your existing configuration (it will prompt for confirmation), so make sure you have committed your code to a source control (e.g. git) first**.
|
||||
There are certain configuration settings which can **only** be specified by hand, in which case the first approach is still best.
|
||||
1. RISKY: Modify the generated build-tool config by hand. Be aware that if you re-run `yo confit` it will attempt to overwrite your changes. So commit your changes to source control first.
|
||||
|
||||
Additionally, the **currently-generated** configuration can be extended in the following ways:
|
||||
|
||||
- The task configuration is defined in [package.json](package.json). It is possible to change the task definitions to add your own sub-tasks.
|
||||
You can also use the `pre...` and `post...` script-name prefixes to run commands before (pre) and after (post) the generated commands.
|
||||
|
||||
- The `entryPoint.entryPoints` string in [confit.yml](confit.yml) is designed to be edited manually. It represents the starting-point(s) of the application (like a `main()` function). A NodeJS application has one entry point. E.g. `src/index.js`
|
||||
|
||||
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
- Thank you for your eagerness to contribute, pull requests are encouraged!
|
||||
|
||||
## Guidelines
|
||||
|
||||
- Any new fixes are features should include new or updated [tests](/test).
|
||||
- Commits follow the [AngularJS Git Commit Message Conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit), please review and commit accordingly
|
||||
- Submit your pull requests to the `master` branch, these will normally be merged into a seperate branch for any finally changes before being merged into `master`.
|
||||
- Submit any bugs or requests to the issues page in Github.
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Tyler Stewart
|
||||
Copyright (c) 2018 Tyler Stewart
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
169
README.md
169
README.md
@@ -14,12 +14,8 @@
|
||||
<img alt="npm" src="https://img.shields.io/npm/dm/ftp-srv.svg?style=for-the-badge" />
|
||||
</a>
|
||||
|
||||
<a href="https://circleci.com/gh/trs/ftp-srv">
|
||||
<img alt="npm" src="https://img.shields.io/circleci/project/github/trs/ftp-srv.svg?style=for-the-badge" />
|
||||
</a>
|
||||
|
||||
<a href="https://coveralls.io/github/trs/ftp-srv?branch=master">
|
||||
<img alt="npm" src="https://img.shields.io/coveralls/github/trs/ftp-srv.svg?style=for-the-badge" />
|
||||
<a href="https://circleci.com/gh/trs/workflows/ftp-srv/tree/master">
|
||||
<img alt="circleci" src="https://img.shields.io/circleci/project/github/trs/ftp-srv/master.svg?style=for-the-badge" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
@@ -30,6 +26,7 @@
|
||||
- [Install](#install)
|
||||
- [Usage](#usage)
|
||||
- [API](#api)
|
||||
- [CLI](#cli)
|
||||
- [Events](#events)
|
||||
- [Supported Commands](#supported-commands)
|
||||
- [File System](#file-system)
|
||||
@@ -46,7 +43,7 @@
|
||||
- Promise based API
|
||||
|
||||
## Install
|
||||
`npm install ftp-srv --save`
|
||||
`npm install ftp-srv --save`
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -54,7 +51,7 @@
|
||||
// Quick start
|
||||
|
||||
const FtpSrv = require('ftp-srv');
|
||||
const ftpServer = new FtpSrv('ftp://0.0.0.0:9876', { options ... });
|
||||
const ftpServer = new FtpSrv({ options ... });
|
||||
|
||||
ftpServer.on('login', (data, resolve, reject) => { ... });
|
||||
...
|
||||
@@ -65,49 +62,57 @@ ftpServer.listen()
|
||||
|
||||
## API
|
||||
|
||||
### `new FtpSrv(url, [{options}])`
|
||||
### `new FtpSrv({options})`
|
||||
#### url
|
||||
[URL string](https://nodejs.org/api/url.html#url_url_strings_and_url_objects) indicating the protocol, hostname, and port to listen on for connections.
|
||||
[URL string](https://nodejs.org/api/url.html#url_url_strings_and_url_objects) indicating the protocol, hostname, and port to listen on for connections.
|
||||
Supported protocols:
|
||||
- `ftp` Plain FTP
|
||||
- `ftps` Implicit FTP over TLS
|
||||
- `ftps` Implicit FTP over TLS
|
||||
|
||||
_Note:_ The hostname must be the external IP address to accept external connections. Setting the hostname to `0.0.0.0` will automatically set the external IP.
|
||||
_Note:_ The hostname must be the external IP address to accept external connections. `0.0.0.0` will listen on any available hosts for server and passive connections.
|
||||
__Default:__ `"ftp://127.0.0.1:21"`
|
||||
|
||||
#### options
|
||||
#### `pasv_url`
|
||||
The hostname to provide a client when attempting a passive connection (`PASV`). This defaults to the provided `url` hostname.
|
||||
|
||||
##### `pasv_range`
|
||||
A starting port (eg `8000`) or a range (eg `"8000-9000"`) to accept passive connections.
|
||||
This range is then queried for an available port to use when required.
|
||||
__Default:__ `22`
|
||||
_Note:_ If set to `0.0.0.0`, this will automatically resolve to the external IP of the box.
|
||||
__Default:__ `"127.0.0.1"`
|
||||
|
||||
##### `greeting`
|
||||
#### `pasv_min`
|
||||
Tne starting port to accept passive connections.
|
||||
__Default:__ `1024`
|
||||
|
||||
#### `pasv_max`
|
||||
The ending port to accept passive connections.
|
||||
The range is then queried for an available port to use when required.
|
||||
__Default:__ `65535`
|
||||
|
||||
#### `greeting`
|
||||
A human readable array of lines or string to send when a client connects.
|
||||
__Default:__ `null`
|
||||
|
||||
##### `tls`
|
||||
#### `tls`
|
||||
Node [TLS secure context object](https://nodejs.org/api/tls.html#tls_tls_createsecurecontext_options) used for implicit (`ftps` protocol) or explicit (`AUTH TLS`) connections.
|
||||
__Default:__ `false`
|
||||
|
||||
##### `anonymous`
|
||||
#### `anonymous`
|
||||
If true, will allow clients to authenticate using the username `anonymous`, not requiring a password from the user.
|
||||
Can also set as a string which allows users to authenticate using the username provided.
|
||||
The `login` event is then sent with the provided username and `@anonymous` as the password.
|
||||
__Default:__ `false`
|
||||
|
||||
##### `blacklist`
|
||||
#### `blacklist`
|
||||
Array of commands that are not allowed.
|
||||
Response code `502` is sent to clients sending one of these commands.
|
||||
__Example:__ `['RMD', 'RNFR', 'RNTO']` will not allow users to delete directories or rename any files.
|
||||
__Default:__ `[]`
|
||||
|
||||
##### `whitelist`
|
||||
#### `whitelist`
|
||||
Array of commands that are only allowed.
|
||||
Response code `502` is sent to clients sending any other command.
|
||||
__Default:__ `[]`
|
||||
|
||||
##### `file_format`
|
||||
#### `file_format`
|
||||
Sets the format to use for file stat queries such as `LIST`.
|
||||
__Default:__ `"ls"`
|
||||
__Allowable values:__
|
||||
@@ -116,16 +121,65 @@ __Allowable values:__
|
||||
- `function () {}` A custom function returning a format or promise for one.
|
||||
- Only one argument is passed in: a node [file stat](https://nodejs.org/api/fs.html#fs_class_fs_stats) object with additional file `name` parameter
|
||||
|
||||
##### `log`
|
||||
#### `log`
|
||||
A [bunyan logger](https://github.com/trentm/node-bunyan) instance. Created by default.
|
||||
|
||||
## CLI
|
||||
|
||||
`ftp-srv` also comes with a builtin CLI.
|
||||
|
||||
```bash
|
||||
$ ftp-srv [url] [options]
|
||||
```
|
||||
|
||||
```bash
|
||||
$ ftp-srv ftp://0.0.0.0:9876 --root ~/Documents
|
||||
```
|
||||
|
||||
#### `url`
|
||||
|
||||
Set the listening URL.
|
||||
|
||||
Defaults to `ftp://127.0.0.1:21`
|
||||
|
||||
#### `--root` / `-r`
|
||||
|
||||
Set the default root directory for users.
|
||||
|
||||
Defaults to the current directory.
|
||||
|
||||
#### `--credentials` / `-c`
|
||||
|
||||
Set the path to a json credentials file.
|
||||
|
||||
Format:
|
||||
|
||||
```js
|
||||
[
|
||||
{
|
||||
"username": "...",
|
||||
"password": "...",
|
||||
"root": "..." // Root directory
|
||||
},
|
||||
...
|
||||
]
|
||||
```
|
||||
|
||||
#### `--username`
|
||||
|
||||
Set the username for the only user. Do not provide an argument to allow anonymous login.
|
||||
|
||||
#### `--password`
|
||||
|
||||
Set the password for the given `username`.
|
||||
|
||||
## Events
|
||||
|
||||
The `FtpSrv` class extends the [node net.Server](https://nodejs.org/api/net.html#net_class_net_server). Some custom events can be resolved or rejected, such as `login`.
|
||||
|
||||
### `login`
|
||||
```js
|
||||
on('login', {connection, username, password}, resolve, reject) => { ... }
|
||||
ftpServer.on('login', ({connection, username, password}, resolve, reject) => { ... });
|
||||
```
|
||||
|
||||
Occurs when a client is attempting to login. Here you can resolve the login request by username and password.
|
||||
@@ -133,7 +187,7 @@ Occurs when a client is attempting to login. Here you can resolve the login requ
|
||||
`connection` [client class object](src/connection.js)
|
||||
`username` string of username from `USER` command
|
||||
`password` string of password from `PASS` command
|
||||
`resolve` takes an object of arguments:
|
||||
`resolve` takes an object of arguments:
|
||||
- `fs`
|
||||
- Set a custom file system class for this connection to use.
|
||||
- See [File System](#file-system) for implementation details.
|
||||
@@ -152,15 +206,35 @@ Occurs when a client is attempting to login. Here you can resolve the login requ
|
||||
|
||||
### `client-error`
|
||||
```js
|
||||
on('client-error', {connection, context, error}) => { ... }
|
||||
ftpServer.on('client-error', ({connection, context, error}) => { ... });
|
||||
```
|
||||
|
||||
Occurs when an error arises in the client connection.
|
||||
|
||||
`connection` [client class object](src/connection.js)
|
||||
`context` string of where the error occured
|
||||
`context` string of where the error occurred
|
||||
`error` error object
|
||||
|
||||
### `RETR`
|
||||
```js
|
||||
connection.on('RETR', (error, filePath) => { ... });
|
||||
```
|
||||
|
||||
Occurs when a file is downloaded.
|
||||
|
||||
`error` if successful, will be `null`
|
||||
`filePath` location to which file was downloaded
|
||||
|
||||
### `STOR`
|
||||
```js
|
||||
connection.on('STOR', (error, fileName) => { ... });
|
||||
```
|
||||
|
||||
Occurs when a file is uploaded.
|
||||
|
||||
`error` if successful, will be `null`
|
||||
`fileName` name of the file that was uploaded
|
||||
|
||||
## Supported Commands
|
||||
|
||||
See the [command registry](src/commands/registration) for a list of all implemented FTP commands.
|
||||
@@ -170,7 +244,7 @@ The default [file system](src/fs.js) can be overwritten to use your own implemen
|
||||
This can allow for virtual file systems, and more.
|
||||
Each connection can set it's own file system based on the user.
|
||||
|
||||
The default file system is exported and can be extended as needed:
|
||||
The default file system is exported and can be extended as needed:
|
||||
```js
|
||||
const {FtpSrv, FileSystem} = require('ftp-srv');
|
||||
|
||||
@@ -188,52 +262,52 @@ class MyFileSystem extends FileSystem {
|
||||
Custom file systems can implement the following variables depending on the developers needs:
|
||||
|
||||
### Methods
|
||||
#### [`currentDirectory()`](src/fs.js#L29)
|
||||
#### [`currentDirectory()`](src/fs.js#L40)
|
||||
Returns a string of the current working directory
|
||||
__Used in:__ `PWD`
|
||||
|
||||
#### [`get(fileName)`](src/fs.js#L33)
|
||||
#### [`get(fileName)`](src/fs.js#L44)
|
||||
Returns a file stat object of file or directory
|
||||
__Used in:__ `LIST`, `NLST`, `STAT`, `SIZE`, `RNFR`, `MDTM`
|
||||
|
||||
#### [`list(path)`](src/fs.js#L39)
|
||||
#### [`list(path)`](src/fs.js#L50)
|
||||
Returns array of file and directory stat objects
|
||||
__Used in:__ `LIST`, `NLST`, `STAT`
|
||||
|
||||
#### [`chdir(path)`](src/fs.js#L56)
|
||||
#### [`chdir(path)`](src/fs.js#L67)
|
||||
Returns new directory relative to current directory
|
||||
__Used in:__ `CWD`, `CDUP`
|
||||
|
||||
#### [`mkdir(path)`](src/fs.js#L96)
|
||||
#### [`mkdir(path)`](src/fs.js#L114)
|
||||
Returns a path to a newly created directory
|
||||
__Used in:__ `MKD`
|
||||
|
||||
#### [`write(fileName, {append, start})`](src/fs.js#L68)
|
||||
Returns a writable stream
|
||||
#### [`write(fileName, {append, start})`](src/fs.js#L79)
|
||||
Returns a writable stream
|
||||
Options:
|
||||
`append` if true, append to existing file
|
||||
`start` if set, specifies the byte offset to write to
|
||||
__Used in:__ `STOR`, `APPE`
|
||||
|
||||
#### [`read(fileName, {start})`](src/fs.js#L75)
|
||||
#### [`read(fileName, {start})`](src/fs.js#L90)
|
||||
Returns a readable stream
|
||||
Options:
|
||||
`start` if set, specifies the byte offset to read from
|
||||
__Used in:__ `RETR`
|
||||
|
||||
#### [`delete(path)`](src/fs.js#L87)
|
||||
#### [`delete(path)`](src/fs.js#L105)
|
||||
Delete a file or directory
|
||||
__Used in:__ `DELE`
|
||||
|
||||
#### [`rename(from, to)`](src/fs.js#L102)
|
||||
#### [`rename(from, to)`](src/fs.js#L120)
|
||||
Renames a file or directory
|
||||
__Used in:__ `RNFR`, `RNTO`
|
||||
|
||||
#### [`chmod(path)`](src/fs.js#L108)
|
||||
#### [`chmod(path)`](src/fs.js#L126)
|
||||
Modifies a file or directory's permissions
|
||||
__Used in:__ `SITE CHMOD`
|
||||
|
||||
#### [`getUniqueName()`](src/fs.js#L113)
|
||||
#### [`getUniqueName()`](src/fs.js#L131)
|
||||
Returns a unique file name to write to
|
||||
__Used in:__ `STOU`
|
||||
|
||||
@@ -242,9 +316,20 @@ __Used in:__ `STOU`
|
||||
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md).
|
||||
|
||||
|
||||
<!--[]-->
|
||||
|
||||
## Contributors
|
||||
|
||||
- [OzairP](https://github.com/OzairP)
|
||||
- [qchar](https://github.com/qchar)
|
||||
- [jorinvo](https://github.com/jorinvo)
|
||||
- [voxsoftware](https://github.com/voxsoftware)
|
||||
- [pkeuter](https://github.com/pkeuter)
|
||||
- [TimLuq](https://github.com/TimLuq)
|
||||
- [edin-mg](https://github.com/edin-m)
|
||||
- [DiegoRBaquero](https://github.com/DiegoRBaquero)
|
||||
- [Johnnyrook777](https://github.com/Johnnyrook777)
|
||||
|
||||
<!--[RM_LICENSE]-->
|
||||
## License
|
||||
|
||||
|
||||
115
bin/index.js
Executable file
115
bin/index.js
Executable file
@@ -0,0 +1,115 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
const yargs = require('yargs');
|
||||
const path = require('path');
|
||||
|
||||
const FtpSrv = require('../src');
|
||||
const errors = require('../src/errors');
|
||||
|
||||
const args = setupYargs();
|
||||
const state = setupState(args);
|
||||
startFtpServer(state);
|
||||
|
||||
function setupYargs() {
|
||||
return yargs
|
||||
.option('credentials', {
|
||||
alias: 'c',
|
||||
describe: 'Load user & pass from json file',
|
||||
normalize: true
|
||||
})
|
||||
.option('username', {
|
||||
describe: 'Blank for anonymous',
|
||||
type: 'string'
|
||||
})
|
||||
.option('password', {
|
||||
describe: 'Password for given username',
|
||||
type: 'string'
|
||||
})
|
||||
.option('root', {
|
||||
alias: 'r',
|
||||
describe: 'Default root directory for users',
|
||||
type: 'string',
|
||||
normalize: true
|
||||
})
|
||||
.option('read-only', {
|
||||
describe: 'Disable write actions such as upload, delete, etc',
|
||||
boolean: true,
|
||||
default: false
|
||||
})
|
||||
.parse();
|
||||
}
|
||||
|
||||
function setupState(_args) {
|
||||
const _state = {};
|
||||
|
||||
function setupOptions() {
|
||||
if (_args._ && _args._.length > 0) {
|
||||
_state.url = _args._[0];
|
||||
}
|
||||
_state.anonymous = _args.username === '';
|
||||
}
|
||||
|
||||
function setupRoot() {
|
||||
const dirPath = _args.root;
|
||||
if (dirPath) {
|
||||
_state.root = process.cwd();
|
||||
} else {
|
||||
_state.root = dirPath;
|
||||
}
|
||||
}
|
||||
|
||||
function setupCredentials() {
|
||||
_state.credentials = {};
|
||||
|
||||
const setCredentials = (username, password, root = null) => {
|
||||
_state.credentials[username] = {
|
||||
password,
|
||||
root
|
||||
};
|
||||
};
|
||||
|
||||
if (_args.credentials) {
|
||||
const credentialsFile = path.resolve(_args.credentials);
|
||||
const credentials = require(credentialsFile);
|
||||
|
||||
for (const cred of credentials) {
|
||||
setCredentials(cred.username, cred.password, cred.root);
|
||||
}
|
||||
} else if (_args.username) {
|
||||
setCredentials(_args.username, _args.password);
|
||||
}
|
||||
}
|
||||
|
||||
function setupCommandBlacklist() {
|
||||
if (_args.readOnly) {
|
||||
_state.blacklist = ['ALLO', 'APPE', 'DELE', 'MKD', 'RMD', 'RNRF', 'RNTO', 'STOR', 'STRU'];
|
||||
}
|
||||
}
|
||||
|
||||
setupOptions();
|
||||
setupRoot();
|
||||
setupCredentials();
|
||||
setupCommandBlacklist();
|
||||
|
||||
return _state;
|
||||
}
|
||||
|
||||
function startFtpServer(_state) {
|
||||
|
||||
function checkLogin(data, resolve, reject) {
|
||||
const user = _state.credentials[data.username]
|
||||
if (_state.anonymous || (user && user.password === data.password)) {
|
||||
return resolve({root: (user && user.root) || _state.root});
|
||||
}
|
||||
|
||||
return reject(new errors.GeneralError('Invalid username or password', 401));
|
||||
}
|
||||
|
||||
const ftpServer = new FtpSrv(_state.url, {
|
||||
anonymous: _state.anonymous,
|
||||
blacklist: _state.blacklist
|
||||
});
|
||||
|
||||
ftpServer.on('login', checkLogin);
|
||||
ftpServer.listen();
|
||||
}
|
||||
44
changelog/v2_to_v3_migation.md
Normal file
44
changelog/v2_to_v3_migation.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Migration Guide - v2 to v3
|
||||
|
||||
The `FtpServer` constructor has been changed to only take one object option. Combining the two just made sense.
|
||||
|
||||
### From:
|
||||
|
||||
```js
|
||||
const server = new FtpServer('ftp://0.0.0.0:21');
|
||||
```
|
||||
|
||||
### To:
|
||||
|
||||
```js
|
||||
const server = new FtpServer({
|
||||
url: 'ftp://0.0.0.0:21'
|
||||
});
|
||||
```
|
||||
|
||||
----
|
||||
|
||||
The `pasv_range` option has been changed to separate integer variables: `pasv_min`, `pasv_max`.
|
||||
|
||||
### From:
|
||||
|
||||
```js
|
||||
const server = new FtpServer(..., {
|
||||
pasv_range: '1000-2000'
|
||||
});
|
||||
```
|
||||
|
||||
### To:
|
||||
|
||||
```js
|
||||
const server = new FtpServer({
|
||||
pasv_min: 1000,
|
||||
pasv_max: 2000
|
||||
})
|
||||
```
|
||||
|
||||
----
|
||||
|
||||
The default passive port range has been changed to `1024` - `65535`
|
||||
|
||||
----
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"reporterEnabled": "mocha-pretty-bunyan-nyan",
|
||||
"reporterEnabled": "spec",
|
||||
"mochaJunitReporterReporterOptions": {
|
||||
"mochaFile": "reports/junit.xml"
|
||||
}
|
||||
|
||||
49
confit.yml
49
confit.yml
@@ -1,49 +0,0 @@
|
||||
generator-confit:
|
||||
app:
|
||||
_version: 462ecd915fd9db1aef6a37c2b5ce8b58b80c18ba
|
||||
buildProfile: Latest
|
||||
copyrightOwner: Tyler Stewart
|
||||
license: MIT
|
||||
projectType: node
|
||||
publicRepository: true
|
||||
repositoryType: GitHub
|
||||
paths:
|
||||
_version: 780b129e0c7e5cab7e29c4f185bcf78524593a33
|
||||
config:
|
||||
configDir: config/
|
||||
input:
|
||||
srcDir: src/
|
||||
unitTestDir: test/
|
||||
output:
|
||||
prodDir: dist/
|
||||
reportDir: reports/
|
||||
buildJS:
|
||||
_version: ead8ce4280b07d696aff499a5fca1a933727582f
|
||||
framework: []
|
||||
frameworkScripts: []
|
||||
outputFormat: ES6
|
||||
sourceFormat: ES6
|
||||
entryPoint:
|
||||
_version: 39082c3df887fbc08744dfd088c25465e7a2e3a4
|
||||
entryPoints:
|
||||
main:
|
||||
- src/index.js
|
||||
testUnit:
|
||||
_version: 30eee42a88ee42cce4f1ae48fe0cbe81647d189a
|
||||
testDependencies: []
|
||||
testFramework: mocha
|
||||
verify:
|
||||
_version: 30ae86c5022840a01fc08833e238a82c683fa1c7
|
||||
jsCodingStandard: none
|
||||
documentation:
|
||||
_version: b1658da3278b16d1982212f5e8bc05348af20e0b
|
||||
generateDocs: false
|
||||
release:
|
||||
_version: 47f220593935b502abf17cb34a396f692e453c49
|
||||
checkCodeCoverage: true
|
||||
commitMessageFormat: Conventional
|
||||
useSemantic: true
|
||||
sampleApp:
|
||||
_version: 00c0a2c6fc0ed17fcccce2d548d35896121e58ba
|
||||
createSampleApp: false
|
||||
zzfinish: {}
|
||||
19
ftp-srv.d.ts
vendored
19
ftp-srv.d.ts
vendored
@@ -1,5 +1,6 @@
|
||||
import * as tls from 'tls'
|
||||
import { Stats } from 'fs'
|
||||
import { EventEmitter } from 'events';
|
||||
|
||||
export class FileSystem {
|
||||
|
||||
@@ -40,7 +41,7 @@ export class FileSystem {
|
||||
getUniqueName(): string;
|
||||
}
|
||||
|
||||
export class FtpConnection {
|
||||
export class FtpConnection extends EventEmitter {
|
||||
server: FtpServer;
|
||||
id: string;
|
||||
log: any;
|
||||
@@ -58,18 +59,20 @@ export class FtpConnection {
|
||||
}
|
||||
|
||||
export interface FtpServerOptions {
|
||||
pasv_range?: number | string,
|
||||
url?: string,
|
||||
pasv_min?: number,
|
||||
pasv_max?: number,
|
||||
greeting?: string | string[],
|
||||
tls?: tls.SecureContext | false,
|
||||
anonymous?: boolean,
|
||||
blacklist?: Array<string>,
|
||||
whitelist?: Array<string>,
|
||||
file_format?: (stat: Stats) => string | Promise<string> | "ls" | "ep",
|
||||
log?: any
|
||||
log?: any,
|
||||
}
|
||||
|
||||
export class FtpServer {
|
||||
constructor(url: string, options?: FtpServerOptions);
|
||||
export class FtpServer extends EventEmitter {
|
||||
constructor(options?: FtpServerOptions);
|
||||
|
||||
readonly isTLS: boolean;
|
||||
|
||||
@@ -77,7 +80,7 @@ export class FtpServer {
|
||||
|
||||
emitPromise(action: any, ...data: any[]): Promise<any>;
|
||||
|
||||
emit(action: any, ...data: any[]): void;
|
||||
// emit is exported from super class
|
||||
|
||||
setupTLS(_tls: boolean): boolean | {
|
||||
cert: string;
|
||||
@@ -107,7 +110,7 @@ export class FtpServer {
|
||||
whitelist?: Array<string>
|
||||
}) => void,
|
||||
reject: (err?: Error) => void
|
||||
) => void)
|
||||
) => void): this;
|
||||
|
||||
on(event: "client-error", listener: (
|
||||
data: {
|
||||
@@ -115,7 +118,7 @@ export class FtpServer {
|
||||
context: string,
|
||||
error: Error,
|
||||
}
|
||||
) => void)
|
||||
) => void): this;
|
||||
}
|
||||
|
||||
export {FtpServer as FtpSrv};
|
||||
|
||||
@@ -1,6 +1,8 @@
|
||||
const FtpSrv = require('./src');
|
||||
const FileSystem = require('./src/fs');
|
||||
const errors = require('./src/errors');
|
||||
|
||||
module.exports = FtpSrv;
|
||||
module.exports.FtpSrv = FtpSrv;
|
||||
module.exports.FileSystem = FileSystem;
|
||||
module.exports.ftpErrors = errors;
|
||||
|
||||
12338
package-lock.json
generated
12338
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
42
package.json
42
package.json
@@ -14,34 +14,28 @@
|
||||
"license": "MIT",
|
||||
"files": [
|
||||
"src",
|
||||
"bin",
|
||||
"ftp-srv.d.ts"
|
||||
],
|
||||
"main": "ftp-srv.js",
|
||||
"bin": "./bin/index.js",
|
||||
"types": "./ftp-srv.d.ts",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/trs/ftp-srv"
|
||||
},
|
||||
"scripts": {
|
||||
"pre-release": "npm-run-all verify test:coverage build ",
|
||||
"build": "cross-env NODE_ENV=production npm run clean:prod",
|
||||
"clean:prod": "rimraf dist/",
|
||||
"pre-release": "npm run verify",
|
||||
"commitmsg": "cz-customizable-ghooks",
|
||||
"dev": "cross-env NODE_ENV=development npm run verify:watch",
|
||||
"prepush": "npm-run-all verify test:coverage --silent",
|
||||
"prepush": "npm-run-all verify test:once --silent",
|
||||
"semantic-release": "semantic-release",
|
||||
"start": "npm run dev",
|
||||
"test": "npm run test:unit",
|
||||
"test:check-coverage": "nyc check-coverage",
|
||||
"test:coverage": "npm-run-all test:unit:once test:check-coverage --silent",
|
||||
"test:unit": "cross-env NODE_ENV=test nyc mocha --opts config/testUnit/mocha.opts -w",
|
||||
"test:unit:once": "cross-env NODE_ENV=test nyc mocha --opts config/testUnit/mocha.opts",
|
||||
"upload-coverage": "cat reports/coverage/lcov.info | coveralls",
|
||||
"test": "cross-env NODE_ENV=test mocha --opts config/testUnit/mocha.opts -w",
|
||||
"test:once": "cross-env NODE_ENV=test mocha --opts config/testUnit/mocha.opts",
|
||||
"verify": "npm run verify:js --silent",
|
||||
"verify:js": "eslint -c config/verify/.eslintrc \"src/**/*.js\" \"test/**/*.js\" \"config/**/*.js\" && echo ✅ verify:js success",
|
||||
"verify:js:fix": "eslint --fix -c config/verify/.eslintrc \"src/**/*.js\" \"test/**/*.js\" \"config/**/*.js\" && echo ✅ verify:js:fix success",
|
||||
"verify:js:watch": "chokidar 'src/**/*.js' 'test/**/*.js' 'config/**/*.js' -c 'npm run verify:js:fix' --initial --silent",
|
||||
"verify:watch": "npm run verify:js:watch --silent"
|
||||
"verify:js:fix": "eslint --fix -c config/verify/.eslintrc \"src/**/*.js\" \"test/**/*.js\" \"config/**/*.js\" && echo ✅ verify:js:fix success"
|
||||
},
|
||||
"release": {
|
||||
"verifyConditions": "condition-circle"
|
||||
@@ -57,16 +51,16 @@
|
||||
"dependencies": {
|
||||
"bluebird": "^3.5.1",
|
||||
"bunyan": "^1.8.12",
|
||||
"lodash": "^4.17.4",
|
||||
"moment": "^2.19.1",
|
||||
"uuid": "^3.1.0"
|
||||
"ip": "^1.1.5",
|
||||
"lodash": "^4.17.10",
|
||||
"moment": "^2.22.1",
|
||||
"uuid": "^3.2.1",
|
||||
"yargs": "^11.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@icetee/ftp": "^0.3.15",
|
||||
"@icetee/ftp": "^1.0.2",
|
||||
"chai": "^4.0.2",
|
||||
"chokidar-cli": "1.2.0",
|
||||
"condition-circle": "^1.6.0",
|
||||
"coveralls": "2.13.1",
|
||||
"cross-env": "3.1.4",
|
||||
"cz-customizable": "5.2.0",
|
||||
"cz-customizable-ghooks": "1.5.0",
|
||||
@@ -78,18 +72,16 @@
|
||||
"eslint-plugin-node": "5.1.1",
|
||||
"husky": "0.13.3",
|
||||
"istanbul": "0.4.5",
|
||||
"mocha": "3.5.0",
|
||||
"mocha": "^5.2.0",
|
||||
"mocha-junit-reporter": "1.13.0",
|
||||
"mocha-multi-reporters": "1.1.5",
|
||||
"mocha-pretty-bunyan-nyan": "^1.0.4",
|
||||
"npm-run-all": "4.0.2",
|
||||
"nyc": "11.1.0",
|
||||
"npm-run-all": "^4.1.3",
|
||||
"rimraf": "2.6.1",
|
||||
"semantic-release": "^11.0.2",
|
||||
"semantic-release": "^15.10.6",
|
||||
"sinon": "^2.3.5"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=6.x",
|
||||
"npm": ">=3.9.5"
|
||||
"npm": ">=5.x"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -3,6 +3,8 @@ const Promise = require('bluebird');
|
||||
|
||||
const REGISTRY = require('./registry');
|
||||
|
||||
const CMD_FLAG_REGEX = new RegExp(/^-(\w{1})$/);
|
||||
|
||||
class FtpCommands {
|
||||
constructor(connection) {
|
||||
this.connection = connection;
|
||||
@@ -13,15 +15,18 @@ class FtpCommands {
|
||||
|
||||
parse(message) {
|
||||
const strippedMessage = message.replace(/"/g, '');
|
||||
const [directive, ...args] = strippedMessage.split(' ');
|
||||
let [directive, ...args] = strippedMessage.split(' ');
|
||||
directive = _.chain(directive).trim().toUpper().value();
|
||||
|
||||
const parseCommandFlags = !['RETR', 'SIZE', 'STOR'].includes(directive);
|
||||
const params = args.reduce(({arg, flags}, param) => {
|
||||
if (/^-{1,2}[a-zA-Z0-9_]+/.test(param)) flags.push(param);
|
||||
if (parseCommandFlags && CMD_FLAG_REGEX.test(param)) flags.push(param);
|
||||
else arg.push(param);
|
||||
return {arg, flags};
|
||||
}, {arg: [], flags: []});
|
||||
|
||||
const command = {
|
||||
directive: _.chain(directive).trim().toUpper().value(),
|
||||
directive,
|
||||
arg: params.arg.length ? params.arg.join(' ') : null,
|
||||
flags: params.flags,
|
||||
raw: message
|
||||
|
||||
@@ -4,10 +4,10 @@ module.exports = {
|
||||
return this.connector.waitForConnection()
|
||||
.then(socket => {
|
||||
return this.reply(426, {socket})
|
||||
.then(() => this.connector.end())
|
||||
.then(() => this.reply(226));
|
||||
})
|
||||
.catch(() => this.reply(225));
|
||||
.catch(() => this.reply(225))
|
||||
.finally(() => this.connector.end());
|
||||
},
|
||||
syntax: '{{cmd}}',
|
||||
description: 'Abort an active file transfer'
|
||||
|
||||
@@ -20,12 +20,12 @@ module.exports = {
|
||||
};
|
||||
|
||||
function handleTLS() {
|
||||
if (!this.server._tls) return this.reply(502);
|
||||
if (!this.server.options.tls) return this.reply(502);
|
||||
if (this.secure) return this.reply(202);
|
||||
|
||||
return this.reply(234)
|
||||
.then(() => {
|
||||
const secureContext = tls.createSecureContext(this.server._tls);
|
||||
const secureContext = tls.createSecureContext(this.server.options.tls);
|
||||
const secureSocket = new tls.TLSSocket(this.commandSocket, {
|
||||
isServer: true,
|
||||
secureContext
|
||||
|
||||
@@ -7,7 +7,7 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.chdir) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.chdir(command.arg))
|
||||
return Promise.try(() => this.fs.chdir(command.arg))
|
||||
.then(cwd => {
|
||||
const path = cwd ? `"${escapePath(cwd)}"` : undefined;
|
||||
return this.reply(250, path);
|
||||
|
||||
@@ -6,7 +6,7 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.delete) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.delete(command.arg))
|
||||
return Promise.try(() => this.fs.delete(command.arg))
|
||||
.then(() => {
|
||||
return this.reply(250);
|
||||
})
|
||||
|
||||
@@ -16,28 +16,28 @@ module.exports = {
|
||||
const path = command.arg || '.';
|
||||
return this.connector.waitForConnection()
|
||||
.tap(() => this.commandSocket.pause())
|
||||
.then(() => Promise.resolve(this.fs.get(path)))
|
||||
.then(stat => stat.isDirectory() ? Promise.resolve(this.fs.list(path)) : [stat])
|
||||
.then(() => Promise.try(() => this.fs.get(path)))
|
||||
.then(stat => stat.isDirectory() ? Promise.try(() => this.fs.list(path)) : [stat])
|
||||
.then(files => {
|
||||
const getFileMessage = file => {
|
||||
if (simple) return file.name;
|
||||
return getFileStat(file, _.get(this, 'server.options.file_format', 'ls'));
|
||||
};
|
||||
|
||||
const fileList = files.map(file => {
|
||||
return Promise.try(() => files.map(file => {
|
||||
const message = getFileMessage(file);
|
||||
return {
|
||||
raw: true,
|
||||
message,
|
||||
socket: this.connector.socket
|
||||
};
|
||||
});
|
||||
return this.reply(150)
|
||||
.then(() => {
|
||||
if (fileList.length) return this.reply({}, ...fileList);
|
||||
});
|
||||
}));
|
||||
})
|
||||
.then(() => this.reply(226))
|
||||
.tap(() => this.reply(150))
|
||||
.then(fileList => {
|
||||
if (fileList.length) return this.reply({}, ...fileList);
|
||||
})
|
||||
.tap(() => this.reply(226))
|
||||
.catch(Promise.TimeoutError, err => {
|
||||
log.error(err);
|
||||
return this.reply(425, 'No connection established');
|
||||
@@ -46,10 +46,7 @@ module.exports = {
|
||||
log.error(err);
|
||||
return this.reply(451, err.message || 'No directory');
|
||||
})
|
||||
.finally(() => {
|
||||
this.connector.end();
|
||||
this.commandSocket.resume();
|
||||
});
|
||||
.finally(() => this.connector.end().then(() => this.commandSocket.resume()));
|
||||
},
|
||||
syntax: '{{cmd}} [<path>]',
|
||||
description: 'Returns information of a file or directory if specified, else information of the current working directory is returned'
|
||||
|
||||
@@ -7,7 +7,7 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.get) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.get(command.arg))
|
||||
return Promise.try(() => this.fs.get(command.arg))
|
||||
.then(fileStat => {
|
||||
const modificationTime = moment.utc(fileStat.mtime).format('YYYYMMDDHHmmss.SSS');
|
||||
return this.reply(213, modificationTime);
|
||||
|
||||
@@ -7,7 +7,7 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.mkdir) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.mkdir(command.arg))
|
||||
return Promise.try(() => this.fs.mkdir(command.arg))
|
||||
.then(dir => {
|
||||
const path = dir ? `"${escapePath(dir)}"` : undefined;
|
||||
return this.reply(257, path);
|
||||
|
||||
@@ -6,7 +6,7 @@ module.exports = {
|
||||
this.connector = new PassiveConnector(this);
|
||||
return this.connector.setupServer()
|
||||
.then(server => {
|
||||
const address = this.server.url.hostname;
|
||||
const address = this.server.options.pasv_url;
|
||||
const {port} = server.address();
|
||||
const host = address.replace(/\./g, ',');
|
||||
const portByte1 = port / 256 | 0;
|
||||
|
||||
@@ -7,7 +7,7 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.currentDirectory) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.currentDirectory())
|
||||
return Promise.try(() => this.fs.currentDirectory())
|
||||
.then(cwd => {
|
||||
const path = cwd ? `"${escapePath(cwd)}"` : undefined;
|
||||
return this.reply(257, path);
|
||||
|
||||
@@ -9,7 +9,7 @@ module.exports = {
|
||||
if (isNaN(byteCount) || byteCount < 0) return this.reply(501, 'Byte count must be 0 or greater');
|
||||
|
||||
this.restByteCount = byteCount;
|
||||
return this.reply(350, `Resarting next transfer at ${byteCount}`);
|
||||
return this.reply(350, `Restarting next transfer at ${byteCount}`);
|
||||
},
|
||||
syntax: '{{cmd}} <byte-count>',
|
||||
description: 'Restart transfer from the specified point. Resets after any STORE or RETRIEVE'
|
||||
|
||||
@@ -6,10 +6,19 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.read) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
const filePath = command.arg;
|
||||
|
||||
return this.connector.waitForConnection()
|
||||
.tap(() => this.commandSocket.pause())
|
||||
.then(() => Promise.resolve(this.fs.read(command.arg, {start: this.restByteCount})))
|
||||
.then(stream => {
|
||||
.then(() => Promise.try(() => this.fs.read(filePath, {start: this.restByteCount})))
|
||||
.then(fsResponse => {
|
||||
let {stream, clientPath} = fsResponse;
|
||||
if (!stream && !clientPath) {
|
||||
stream = fsResponse;
|
||||
clientPath = filePath;
|
||||
}
|
||||
const serverPath = stream.path || filePath;
|
||||
|
||||
const destroyConnection = (connection, reject) => err => {
|
||||
if (connection) connection.destroy(err);
|
||||
reject(err);
|
||||
@@ -32,21 +41,20 @@ module.exports = {
|
||||
|
||||
return this.reply(150).then(() => stream.resume() && this.connector.socket.resume())
|
||||
.then(() => eventsPromise)
|
||||
.tap(() => this.emit('RETR', null, serverPath))
|
||||
.then(() => this.reply(226, clientPath))
|
||||
.finally(() => stream.destroy && stream.destroy());
|
||||
})
|
||||
.then(() => this.reply(226))
|
||||
.catch(Promise.TimeoutError, err => {
|
||||
log.error(err);
|
||||
return this.reply(425, 'No connection established');
|
||||
})
|
||||
.catch(err => {
|
||||
log.error(err);
|
||||
this.emit('RETR', err);
|
||||
return this.reply(551, err.message);
|
||||
})
|
||||
.finally(() => {
|
||||
this.connector.end();
|
||||
this.commandSocket.resume();
|
||||
});
|
||||
.finally(() => this.connector.end().then(() => this.commandSocket.resume()));
|
||||
},
|
||||
syntax: '{{cmd}} <path>',
|
||||
description: 'Retrieve a copy of the file'
|
||||
|
||||
@@ -7,7 +7,7 @@ module.exports = {
|
||||
if (!this.fs.get) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
const fileName = command.arg;
|
||||
return Promise.resolve(this.fs.get(fileName))
|
||||
return Promise.try(() => this.fs.get(fileName))
|
||||
.then(() => {
|
||||
this.renameFrom = fileName;
|
||||
return this.reply(350);
|
||||
|
||||
@@ -11,7 +11,7 @@ module.exports = {
|
||||
const from = this.renameFrom;
|
||||
const to = command.arg;
|
||||
|
||||
return Promise.resolve(this.fs.rename(from, to))
|
||||
return Promise.try(() => this.fs.rename(from, to))
|
||||
.then(() => {
|
||||
return this.reply(250);
|
||||
})
|
||||
|
||||
@@ -6,7 +6,7 @@ module.exports = function ({log, command} = {}) {
|
||||
|
||||
const [mode, ...fileNameParts] = command.arg.split(' ');
|
||||
const fileName = fileNameParts.join(' ');
|
||||
return Promise.resolve(this.fs.chmod(fileName, parseInt(mode, 8)))
|
||||
return Promise.try(() => this.fs.chmod(fileName, parseInt(mode, 8)))
|
||||
.then(() => {
|
||||
return this.reply(200);
|
||||
})
|
||||
|
||||
@@ -6,7 +6,7 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.get) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.get(command.arg))
|
||||
return Promise.try(() => this.fs.get(command.arg))
|
||||
.then(fileStat => {
|
||||
return this.reply(213, {message: fileStat.size});
|
||||
})
|
||||
|
||||
@@ -11,12 +11,12 @@ module.exports = {
|
||||
if (!this.fs) return this.reply(550, 'File system not instantiated');
|
||||
if (!this.fs.get) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.get(path))
|
||||
return Promise.try(() => this.fs.get(path))
|
||||
.then(stat => {
|
||||
if (stat.isDirectory()) {
|
||||
if (!this.fs.list) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
return Promise.resolve(this.fs.list(path))
|
||||
return Promise.try(() => this.fs.list(path))
|
||||
.then(stats => [213, stats]);
|
||||
}
|
||||
return [212, [stat]];
|
||||
|
||||
@@ -11,10 +11,20 @@ module.exports = {
|
||||
|
||||
return this.connector.waitForConnection()
|
||||
.tap(() => this.commandSocket.pause())
|
||||
.then(() => Promise.resolve(this.fs.write(fileName, {append, start: this.restByteCount})))
|
||||
.then(stream => {
|
||||
.then(() => Promise.try(() => this.fs.write(fileName, {append, start: this.restByteCount})))
|
||||
.then(fsResponse => {
|
||||
let {stream, clientPath} = fsResponse;
|
||||
if (!stream && !clientPath) {
|
||||
stream = fsResponse;
|
||||
clientPath = fileName;
|
||||
}
|
||||
const serverPath = stream.path || fileName;
|
||||
|
||||
const destroyConnection = (connection, reject) => err => {
|
||||
if (connection) connection.destroy(err);
|
||||
if (connection) {
|
||||
if (connection.writeable) connection.end();
|
||||
connection.destroy(err);
|
||||
}
|
||||
reject(err);
|
||||
};
|
||||
|
||||
@@ -30,7 +40,7 @@ module.exports = {
|
||||
stream.write(data, this.transferType, () => this.connector.socket && this.connector.socket.resume());
|
||||
}
|
||||
});
|
||||
this.connector.socket.once('end', () => {
|
||||
this.connector.socket.once('close', () => {
|
||||
if (stream.listenerCount('close')) stream.emit('close');
|
||||
else stream.end();
|
||||
resolve();
|
||||
@@ -41,22 +51,21 @@ module.exports = {
|
||||
this.restByteCount = 0;
|
||||
|
||||
return this.reply(150).then(() => this.connector.socket.resume())
|
||||
.then(() => Promise.join(streamPromise, socketPromise))
|
||||
.then(() => Promise.all([streamPromise, socketPromise]))
|
||||
.tap(() => this.emit('STOR', null, serverPath))
|
||||
.then(() => this.reply(226, clientPath))
|
||||
.finally(() => stream.destroy && stream.destroy());
|
||||
})
|
||||
.then(() => this.reply(226, fileName))
|
||||
.catch(Promise.TimeoutError, err => {
|
||||
log.error(err);
|
||||
return this.reply(425, 'No connection established');
|
||||
})
|
||||
.catch(err => {
|
||||
log.error(err);
|
||||
this.emit('STOR', err);
|
||||
return this.reply(550, err.message);
|
||||
})
|
||||
.finally(() => {
|
||||
this.connector.end();
|
||||
this.commandSocket.resume();
|
||||
});
|
||||
.finally(() => this.connector.end().then(() => this.commandSocket.resume()));
|
||||
},
|
||||
syntax: '{{cmd}} <path>',
|
||||
description: 'Store data as a file at the server site'
|
||||
|
||||
@@ -8,11 +8,9 @@ module.exports = {
|
||||
if (!this.fs.get || !this.fs.getUniqueName) return this.reply(402, 'Not supported by file system');
|
||||
|
||||
const fileName = args.command.arg;
|
||||
return Promise.try(() => {
|
||||
return Promise.resolve(this.fs.get(fileName))
|
||||
.then(() => Promise.resolve(this.fs.getUniqueName()))
|
||||
.catch(() => Promise.resolve(fileName));
|
||||
})
|
||||
return Promise.try(() => this.fs.get(fileName))
|
||||
.then(() => Promise.try(() => this.fs.getUniqueName()))
|
||||
.catch(() => fileName)
|
||||
.then(name => {
|
||||
args.command.arg = name;
|
||||
return stor.call(this, args);
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
const _ = require('lodash');
|
||||
const uuid = require('uuid');
|
||||
const Promise = require('bluebird');
|
||||
const EventEmitter = require('events');
|
||||
|
||||
const BaseConnector = require('./connector/base');
|
||||
const FileSystem = require('./fs');
|
||||
@@ -8,8 +9,9 @@ const Commands = require('./commands');
|
||||
const errors = require('./errors');
|
||||
const DEFAULT_MESSAGE = require('./messages');
|
||||
|
||||
class FtpConnection {
|
||||
class FtpConnection extends EventEmitter {
|
||||
constructor(server, options) {
|
||||
super();
|
||||
this.server = server;
|
||||
this.id = uuid.v4();
|
||||
this.log = options.log.child({id: this.id, ip: this.ip});
|
||||
@@ -32,6 +34,7 @@ class FtpConnection {
|
||||
this.commandSocket.on('close', () => {
|
||||
if (this.connector) this.connector.end();
|
||||
if (this.commandSocket && !this.commandSocket.destroyed) this.commandSocket.destroy();
|
||||
this.removeAllListeners();
|
||||
});
|
||||
}
|
||||
|
||||
@@ -43,7 +46,7 @@ class FtpConnection {
|
||||
|
||||
get ip() {
|
||||
try {
|
||||
return this.dataSocket ? this.dataSocket.remoteAddress : this.commandSocket.remoteAddress;
|
||||
return this.commandSocket ? this.commandSocket.remoteAddress : undefined;
|
||||
} catch (ex) {
|
||||
return null;
|
||||
}
|
||||
|
||||
@@ -34,7 +34,7 @@ class Active extends Connector {
|
||||
this.dataSocket.pause();
|
||||
|
||||
if (this.connection.secure) {
|
||||
const secureContext = tls.createSecureContext(this.server._tls);
|
||||
const secureContext = tls.createSecureContext(this.server.options.tls);
|
||||
const secureSocket = new tls.TLSSocket(this.dataSocket, {
|
||||
isServer: true,
|
||||
secureContext
|
||||
|
||||
@@ -28,12 +28,16 @@ class Connector {
|
||||
|
||||
end() {
|
||||
const closeDataSocket = new Promise(resolve => {
|
||||
if (this.dataSocket) this.dataSocket.end();
|
||||
else resolve();
|
||||
if (this.dataSocket) {
|
||||
this.dataSocket.end().destroy();
|
||||
this.dataSocket = null;
|
||||
}
|
||||
resolve();
|
||||
});
|
||||
const closeDataServer = new Promise(resolve => {
|
||||
if (this.dataServer) this.dataServer.close(() => resolve());
|
||||
else resolve();
|
||||
if (this.dataServer) {
|
||||
this.dataServer.close(() => resolve());
|
||||
} else resolve();
|
||||
});
|
||||
|
||||
return Promise.all([closeDataSocket, closeDataServer])
|
||||
@@ -41,6 +45,8 @@ class Connector {
|
||||
this.dataSocket = null;
|
||||
this.dataServer = null;
|
||||
this.type = false;
|
||||
|
||||
this.connection.connector = new Connector(this);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
const net = require('net');
|
||||
const tls = require('tls');
|
||||
const ip = require('ip');
|
||||
const Promise = require('bluebird');
|
||||
|
||||
const Connector = require('./base');
|
||||
const findPort = require('../helpers/find-port');
|
||||
const errors = require('../errors');
|
||||
|
||||
class Passive extends Connector {
|
||||
@@ -32,10 +32,10 @@ class Passive extends Connector {
|
||||
Promise.resolve();
|
||||
|
||||
return closeExistingServer()
|
||||
.then(() => this.getPort())
|
||||
.then(() => this.server.getNextPasvPort())
|
||||
.then(port => {
|
||||
const connectionHandler = socket => {
|
||||
if (this.connection.commandSocket.remoteAddress !== socket.remoteAddress) {
|
||||
if (!ip.isEqual(this.connection.commandSocket.remoteAddress, socket.remoteAddress)) {
|
||||
this.log.error({
|
||||
pasv_connection: socket.remoteAddress,
|
||||
cmd_connection: this.connection.commandSocket.remoteAddress
|
||||
@@ -47,36 +47,30 @@ class Passive extends Connector {
|
||||
}
|
||||
this.log.trace({port, remoteAddress: socket.remoteAddress}, 'Passive connection fulfilled.');
|
||||
|
||||
if (this.connection.secure) {
|
||||
const secureContext = tls.createSecureContext(this.server._tls);
|
||||
const secureSocket = new tls.TLSSocket(socket, {
|
||||
isServer: true,
|
||||
secureContext
|
||||
});
|
||||
this.dataSocket = secureSocket;
|
||||
} else {
|
||||
this.dataSocket = socket;
|
||||
}
|
||||
this.dataSocket = socket;
|
||||
this.dataSocket.connected = true;
|
||||
this.dataSocket.setEncoding(this.connection.transferType);
|
||||
this.dataSocket.on('error', err => this.server && this.server.emit('client-error', {connection: this.connection, context: 'dataSocket', error: err}));
|
||||
this.dataSocket.on('close', () => {
|
||||
this.dataSocket.once('close', () => {
|
||||
this.log.trace('Passive connection closed');
|
||||
this.end();
|
||||
});
|
||||
};
|
||||
|
||||
this.dataSocket = null;
|
||||
this.dataServer = net.createServer({pauseOnConnect: true}, connectionHandler);
|
||||
|
||||
const serverOptions = Object.assign({}, this.connection.secure ? this.server.options.tls : {}, {pauseOnConnect: true});
|
||||
this.dataServer = (this.connection.secure ? tls : net).createServer(serverOptions, connectionHandler);
|
||||
this.dataServer.maxConnections = 1;
|
||||
|
||||
this.dataServer.on('error', err => this.server && this.server.emit('client-error', {connection: this.connection, context: 'dataServer', error: err}));
|
||||
this.dataServer.on('close', () => {
|
||||
this.dataServer.once('close', () => {
|
||||
this.log.trace('Passive server closed');
|
||||
this.dataServer = null;
|
||||
this.end();
|
||||
});
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
this.dataServer.listen(port, err => {
|
||||
this.dataServer.listen(port, this.server.url.hostname, err => {
|
||||
if (err) reject(err);
|
||||
else {
|
||||
this.log.debug({port}, 'Passive connection listening');
|
||||
@@ -87,15 +81,5 @@ class Passive extends Connector {
|
||||
});
|
||||
}
|
||||
|
||||
getPort() {
|
||||
if (this.server.options.pasv_range) {
|
||||
const [min, max] = typeof this.server.options.pasv_range === 'string' ?
|
||||
this.server.options.pasv_range.split('-').map(v => v ? parseInt(v) : v) :
|
||||
[this.server.options.pasv_range];
|
||||
return findPort(min, max);
|
||||
}
|
||||
throw new errors.ConnectorError('Invalid pasv_range');
|
||||
}
|
||||
|
||||
}
|
||||
module.exports = Passive;
|
||||
|
||||
47
src/fs.js
47
src/fs.js
@@ -8,18 +8,31 @@ const errors = require('./errors');
|
||||
class FileSystem {
|
||||
constructor(connection, {root, cwd} = {}) {
|
||||
this.connection = connection;
|
||||
this.cwd = cwd || nodePath.sep;
|
||||
this.root = root || process.cwd();
|
||||
this.cwd = cwd ? nodePath.join(nodePath.sep, cwd) : nodePath.sep;
|
||||
this._root = nodePath.resolve(root || process.cwd());
|
||||
}
|
||||
|
||||
_resolvePath(path = '') {
|
||||
const isFromRoot = _.startsWith(path, '/') || _.startsWith(path, nodePath.sep);
|
||||
const cwd = isFromRoot ? nodePath.sep : this.cwd || nodePath.sep;
|
||||
const serverPath = nodePath.join(nodePath.sep, cwd, path);
|
||||
const fsPath = nodePath.join(this.root, serverPath);
|
||||
get root() {
|
||||
return this._root;
|
||||
}
|
||||
|
||||
_resolvePath(path = '.') {
|
||||
const clientPath = (() => {
|
||||
path = nodePath.normalize(path);
|
||||
if (nodePath.isAbsolute(path)) {
|
||||
return nodePath.join(path);
|
||||
} else {
|
||||
return nodePath.join(this.cwd, path);
|
||||
}
|
||||
})();
|
||||
|
||||
const fsPath = (() => {
|
||||
const resolvedPath = nodePath.resolve(this.root, `.${nodePath.sep}${clientPath}`);
|
||||
return nodePath.join(resolvedPath);
|
||||
})();
|
||||
|
||||
return {
|
||||
serverPath,
|
||||
clientPath,
|
||||
fsPath
|
||||
};
|
||||
}
|
||||
@@ -52,34 +65,40 @@ class FileSystem {
|
||||
}
|
||||
|
||||
chdir(path = '.') {
|
||||
const {fsPath, serverPath} = this._resolvePath(path);
|
||||
const {fsPath, clientPath} = this._resolvePath(path);
|
||||
return fs.statAsync(fsPath)
|
||||
.tap(stat => {
|
||||
if (!stat.isDirectory()) throw new errors.FileSystemError('Not a valid directory');
|
||||
})
|
||||
.then(() => {
|
||||
this.cwd = serverPath;
|
||||
this.cwd = clientPath;
|
||||
return this.currentDirectory();
|
||||
});
|
||||
}
|
||||
|
||||
write(fileName, {append = false, start = undefined} = {}) {
|
||||
const {fsPath} = this._resolvePath(fileName);
|
||||
const {fsPath, clientPath} = this._resolvePath(fileName);
|
||||
const stream = fs.createWriteStream(fsPath, {flags: !append ? 'w+' : 'a+', start});
|
||||
stream.once('error', () => fs.unlinkAsync(fsPath));
|
||||
stream.once('close', () => stream.end());
|
||||
return stream;
|
||||
return {
|
||||
stream,
|
||||
clientPath
|
||||
};
|
||||
}
|
||||
|
||||
read(fileName, {start = undefined} = {}) {
|
||||
const {fsPath} = this._resolvePath(fileName);
|
||||
const {fsPath, clientPath} = this._resolvePath(fileName);
|
||||
return fs.statAsync(fsPath)
|
||||
.tap(stat => {
|
||||
if (stat.isDirectory()) throw new errors.FileSystemError('Cannot read a directory');
|
||||
})
|
||||
.then(() => {
|
||||
const stream = fs.createReadStream(fsPath, {flags: 'r', start});
|
||||
return stream;
|
||||
return {
|
||||
stream,
|
||||
clientPath
|
||||
};
|
||||
});
|
||||
}
|
||||
|
||||
|
||||
@@ -18,7 +18,8 @@ module.exports = function (fileStat, format = 'ls') {
|
||||
function ls(fileStat) {
|
||||
const now = moment.utc();
|
||||
const mtime = moment.utc(new Date(fileStat.mtime));
|
||||
const dateFormat = now.diff(mtime, 'months') < 6 ? 'MMM DD HH:mm' : 'MMM DD YYYY';
|
||||
const timeDiff = now.diff(mtime, 'months');
|
||||
const dateFormat = timeDiff < 6 ? 'MMM DD HH:mm' : 'MMM DD YYYY';
|
||||
|
||||
return [
|
||||
fileStat.mode ? [
|
||||
|
||||
@@ -2,26 +2,35 @@ const net = require('net');
|
||||
const Promise = require('bluebird');
|
||||
const errors = require('../errors');
|
||||
|
||||
module.exports = function (min = 1, max = undefined) {
|
||||
return new Promise((resolve, reject) => {
|
||||
let checkPort = min;
|
||||
let portCheckServer = net.createServer();
|
||||
portCheckServer.maxConnections = 0;
|
||||
portCheckServer.on('error', () => {
|
||||
if (checkPort < 65535 && (!max || checkPort < max)) {
|
||||
checkPort = checkPort + 1;
|
||||
portCheckServer.listen(checkPort);
|
||||
} else {
|
||||
reject(new errors.GeneralError('Unable to find open port', 500));
|
||||
}
|
||||
});
|
||||
portCheckServer.on('listening', () => {
|
||||
const {port} = portCheckServer.address();
|
||||
portCheckServer.close(() => {
|
||||
portCheckServer = null;
|
||||
resolve(port);
|
||||
});
|
||||
});
|
||||
portCheckServer.listen(checkPort);
|
||||
function* portNumberGenerator(min, max) {
|
||||
let current = min;
|
||||
while (true) {
|
||||
if (current > 65535 || current > max) {
|
||||
current = min;
|
||||
}
|
||||
yield current++;
|
||||
}
|
||||
}
|
||||
|
||||
function getNextPortFactory(min, max = Infinity) {
|
||||
const nextPortNumber = portNumberGenerator(min, max);
|
||||
const portCheckServer = net.createServer();
|
||||
portCheckServer.maxConnections = 0;
|
||||
portCheckServer.on('error', () => {
|
||||
portCheckServer.listen(nextPortNumber.next().value);
|
||||
});
|
||||
|
||||
return () => new Promise(resolve => {
|
||||
portCheckServer.once('listening', () => {
|
||||
const {port} = portCheckServer.address();
|
||||
portCheckServer.close(() => resolve(port));
|
||||
});
|
||||
portCheckServer.listen(nextPortNumber.next().value);
|
||||
})
|
||||
.catch(RangeError, err => Promise.reject(new errors.ConnectorError(err.message)));
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
getNextPortFactory,
|
||||
portNumberGenerator
|
||||
};
|
||||
|
||||
67
src/index.js
67
src/index.js
@@ -4,33 +4,40 @@ const nodeUrl = require('url');
|
||||
const buyan = require('bunyan');
|
||||
const net = require('net');
|
||||
const tls = require('tls');
|
||||
const fs = require('fs');
|
||||
const EventEmitter = require('events');
|
||||
|
||||
const Connection = require('./connection');
|
||||
const resolveHost = require('./helpers/resolve-host');
|
||||
const {getNextPortFactory} = require('./helpers/find-port');
|
||||
|
||||
class FtpServer {
|
||||
constructor(url, options = {}) {
|
||||
this.options = _.merge({
|
||||
class FtpServer extends EventEmitter {
|
||||
constructor(options = {}) {
|
||||
super();
|
||||
this.options = Object.assign({
|
||||
log: buyan.createLogger({name: 'ftp-srv'}),
|
||||
url: 'ftp://127.0.0.1:21',
|
||||
pasv_min: 1024,
|
||||
pasv_max: 65535,
|
||||
pasv_url: null,
|
||||
anonymous: false,
|
||||
pasv_range: 22,
|
||||
file_format: 'ls',
|
||||
blacklist: [],
|
||||
whitelist: [],
|
||||
greeting: null,
|
||||
tls: false
|
||||
}, options);
|
||||
|
||||
this._greeting = this.setupGreeting(this.options.greeting);
|
||||
this._features = this.setupFeaturesMessage();
|
||||
this._tls = this.setupTLS(this.options.tls);
|
||||
|
||||
delete this.options.greeting;
|
||||
delete this.options.tls;
|
||||
|
||||
this.connections = {};
|
||||
this.log = this.options.log;
|
||||
this.url = nodeUrl.parse(url || 'ftp://127.0.0.1:21');
|
||||
this.url = nodeUrl.parse(this.options.url);
|
||||
this.getNextPasvPort = getNextPortFactory(
|
||||
_.get(this, 'options.pasv_min'),
|
||||
_.get(this, 'options.pasv_max'));
|
||||
|
||||
const serverConnectionHandler = socket => {
|
||||
let connection = new Connection(this, {log: this.log, socket});
|
||||
@@ -43,29 +50,31 @@ class FtpServer {
|
||||
return connection.reply(220, ...greeting, features)
|
||||
.finally(() => socket.resume());
|
||||
};
|
||||
const serverOptions = _.assign(this.isTLS ? this._tls : {}, {pauseOnConnect: true});
|
||||
const serverOptions = Object.assign({}, this.isTLS ? this.options.tls : {}, {pauseOnConnect: true});
|
||||
|
||||
this.server = (this.isTLS ? tls : net).createServer(serverOptions, serverConnectionHandler);
|
||||
this.server.on('error', err => this.log.error(err, '[Event] error'));
|
||||
this.on = this.server.on.bind(this.server);
|
||||
this.once = this.server.once.bind(this.server);
|
||||
this.listeners = this.server.listeners.bind(this.server);
|
||||
|
||||
process.on('SIGTERM', () => this.quit());
|
||||
process.on('SIGINT', () => this.quit());
|
||||
process.on('SIGQUIT', () => this.quit());
|
||||
const quit = _.debounce(this.quit.bind(this), 100);
|
||||
|
||||
process.on('SIGTERM', quit);
|
||||
process.on('SIGINT', quit);
|
||||
process.on('SIGQUIT', quit);
|
||||
}
|
||||
|
||||
get isTLS() {
|
||||
return this.url.protocol === 'ftps:' && this._tls;
|
||||
return this.url.protocol === 'ftps:' && this.options.tls;
|
||||
}
|
||||
|
||||
listen() {
|
||||
return resolveHost(this.url.hostname)
|
||||
.then(hostname => {
|
||||
this.url.hostname = hostname;
|
||||
return resolveHost(this.options.pasv_url || this.url.hostname)
|
||||
.then(pasvUrl => {
|
||||
this.options.pasv_url = pasvUrl;
|
||||
|
||||
return new Promise((resolve, reject) => {
|
||||
this.server.listen(this.url.port, err => {
|
||||
this.server.once('error', reject);
|
||||
this.server.listen(this.url.port, this.url.hostname, err => {
|
||||
this.server.removeListener('error', reject);
|
||||
if (err) return reject(err);
|
||||
this.log.info({
|
||||
protocol: this.url.protocol.replace(/\W/g, ''),
|
||||
@@ -81,20 +90,7 @@ class FtpServer {
|
||||
emitPromise(action, ...data) {
|
||||
return new Promise((resolve, reject) => {
|
||||
const params = _.concat(data, [resolve, reject]);
|
||||
this.server.emit(action, ...params);
|
||||
});
|
||||
}
|
||||
|
||||
emit(action, ...data) {
|
||||
this.server.emit(action, ...data);
|
||||
}
|
||||
|
||||
setupTLS(_tls) {
|
||||
if (!_tls) return false;
|
||||
return _.assign({}, _tls, {
|
||||
cert: _tls.cert ? fs.readFileSync(_tls.cert) : undefined,
|
||||
key: _tls.key ? fs.readFileSync(_tls.key) : undefined,
|
||||
ca: _tls.ca ? Array.isArray(_tls.ca) ? _tls.ca.map(_ca => fs.readFileSync(_ca)) : [fs.readFileSync(_tls.ca)] : undefined
|
||||
this.emit.call(this, action, ...params);
|
||||
});
|
||||
}
|
||||
|
||||
@@ -144,7 +140,8 @@ class FtpServer {
|
||||
if (err) this.log.error(err, 'Error closing server');
|
||||
resolve('Closed');
|
||||
});
|
||||
}));
|
||||
}))
|
||||
.then(() => this.removeAllListeners());
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
@@ -20,7 +20,7 @@ describe('FtpCommands', function () {
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
commands = new FtpCommands(mockConnection);
|
||||
|
||||
@@ -64,8 +64,8 @@ describe('FtpCommands', function () {
|
||||
it('two args, with flags: test -l arg1 -A arg2 --zz88A', () => {
|
||||
const cmd = commands.parse('test -l arg1 -A arg2 --zz88A');
|
||||
expect(cmd.directive).to.equal('TEST');
|
||||
expect(cmd.arg).to.equal('arg1 arg2');
|
||||
expect(cmd.flags).to.deep.equal(['-l', '-A', '--zz88A']);
|
||||
expect(cmd.arg).to.equal('arg1 arg2 --zz88A');
|
||||
expect(cmd.flags).to.deep.equal(['-l', '-A']);
|
||||
expect(cmd.raw).to.equal('test -l arg1 -A arg2 --zz88A');
|
||||
});
|
||||
|
||||
@@ -76,6 +76,13 @@ describe('FtpCommands', function () {
|
||||
expect(cmd.flags).to.deep.equal(['-l']);
|
||||
expect(cmd.raw).to.equal('list -l');
|
||||
});
|
||||
|
||||
it('does not check for option flags', () => {
|
||||
const cmd = commands.parse('retr -test');
|
||||
expect(cmd.directive).to.equal('RETR');
|
||||
expect(cmd.arg).to.equal('-test');
|
||||
expect(cmd.flags).to.deep.equal([]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('handle', function () {
|
||||
|
||||
@@ -3,7 +3,7 @@ const {expect} = require('chai');
|
||||
const sinon = require('sinon');
|
||||
|
||||
const CMD = 'ABOR';
|
||||
describe(CMD, function () {
|
||||
describe.skip(CMD, function () {
|
||||
let sandbox;
|
||||
const mockClient = {
|
||||
reply: () => Promise.resolve(),
|
||||
@@ -15,7 +15,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
sandbox.spy(mockClient.connector, 'waitForConnection');
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -8,13 +8,15 @@ describe(CMD, function () {
|
||||
const mockClient = {
|
||||
reply: () => Promise.resolve(),
|
||||
server: {
|
||||
_tls: {}
|
||||
options: {
|
||||
tls: {}
|
||||
}
|
||||
}
|
||||
};
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -16,7 +16,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
sandbox.spy(mockClient.fs, 'chdir');
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'chdir').resolves();
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'delete').resolves();
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
sandbox.stub(ActiveConnector.prototype, 'setupConnection').resolves();
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(PassiveConnector.prototype, 'setupServer').resolves({
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -15,7 +15,7 @@ describe(CMD, function () {
|
||||
},
|
||||
connector: {
|
||||
waitForConnection: () => Promise.resolve({}),
|
||||
end: () => {}
|
||||
end: () => Promise.resolve({})
|
||||
},
|
||||
commandSocket: {
|
||||
resume: () => {},
|
||||
@@ -25,7 +25,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'get').resolves({
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'get').resolves({mtime: 'Mon, 10 Oct 2011 23:24:11 GMT'});
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'mkdir').resolves();
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -15,7 +15,7 @@ describe(CMD, function () {
|
||||
},
|
||||
connector: {
|
||||
waitForConnection: () => Promise.resolve({}),
|
||||
end: () => {}
|
||||
end: () => Promise.resolve({})
|
||||
},
|
||||
commandSocket: {
|
||||
resume: () => {},
|
||||
@@ -25,7 +25,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'get').resolves({
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -15,7 +15,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient, 'login').resolves();
|
||||
|
||||
@@ -12,7 +12,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
sandbox.stub(ActiveConnector.prototype, 'setupConnection').resolves();
|
||||
|
||||
@@ -12,7 +12,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
sandbox.stub(mockClient.fs, 'currentDirectory').resolves();
|
||||
|
||||
@@ -10,7 +10,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'close').resolves();
|
||||
});
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -2,11 +2,13 @@ const Promise = require('bluebird');
|
||||
const bunyan = require('bunyan');
|
||||
const {expect} = require('chai');
|
||||
const sinon = require('sinon');
|
||||
const EventEmitter = require('events');
|
||||
|
||||
const CMD = 'RETR';
|
||||
describe(CMD, function () {
|
||||
let sandbox;
|
||||
let log = bunyan.createLogger({name: CMD});
|
||||
let emitter;
|
||||
const mockClient = {
|
||||
commandSocket: {
|
||||
pause: () => {},
|
||||
@@ -17,18 +19,23 @@ describe(CMD, function () {
|
||||
waitForConnection: () => Promise.resolve({
|
||||
resume: () => {}
|
||||
}),
|
||||
end: () => {}
|
||||
end: () => Promise.resolve({})
|
||||
}
|
||||
};
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.fs = {
|
||||
read: () => {}
|
||||
};
|
||||
|
||||
emitter = new EventEmitter();
|
||||
mockClient.emit = emitter.emit.bind(emitter);
|
||||
mockClient.on = emitter.on.bind(emitter);
|
||||
mockClient.once = emitter.once.bind(emitter);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
afterEach(() => sandbox.restore());
|
||||
@@ -56,6 +63,7 @@ describe(CMD, function () {
|
||||
return Promise.reject(new Promise.TimeoutError());
|
||||
});
|
||||
|
||||
|
||||
return cmdFn({log, command: {arg: 'test.txt'}})
|
||||
.then(() => {
|
||||
expect(mockClient.reply.args[0][0]).to.equal(425);
|
||||
@@ -72,4 +80,20 @@ describe(CMD, function () {
|
||||
expect(mockClient.reply.args[0][0]).to.equal(551);
|
||||
});
|
||||
});
|
||||
|
||||
it('// unsuccessful | emits error event', () => {
|
||||
sandbox.stub(mockClient.connector, 'waitForConnection').callsFake(function () {
|
||||
return Promise.reject(new Error('test'));
|
||||
});
|
||||
|
||||
let errorEmitted = false;
|
||||
emitter.once('RETR', err => {
|
||||
errorEmitted = !!err;
|
||||
});
|
||||
|
||||
return cmdFn({log, command: {arg: 'test.txt'}})
|
||||
.then(() => {
|
||||
expect(errorEmitted).to.equal(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -10,7 +10,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.renameFrom = 'test';
|
||||
mockClient.fs = {
|
||||
|
||||
@@ -10,7 +10,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.renameFrom = 'test';
|
||||
mockClient.fs = {
|
||||
|
||||
@@ -10,7 +10,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../../src/commands/registration/site/${CMD.toLowerCase()}`).bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.fs = {
|
||||
chmod: () => Promise.resolve()
|
||||
|
||||
@@ -17,7 +17,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.stub(mockClient, 'reply').resolves();
|
||||
});
|
||||
|
||||
@@ -10,7 +10,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.fs = {
|
||||
get: () => Promise.resolve({size: 1})
|
||||
|
||||
@@ -10,7 +10,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.fs = {
|
||||
get: () => Promise.resolve({}),
|
||||
|
||||
@@ -2,11 +2,13 @@ const Promise = require('bluebird');
|
||||
const bunyan = require('bunyan');
|
||||
const {expect} = require('chai');
|
||||
const sinon = require('sinon');
|
||||
const EventEmitter = require('events');
|
||||
|
||||
const CMD = 'STOR';
|
||||
describe(CMD, function () {
|
||||
let sandbox;
|
||||
let log = bunyan.createLogger({name: CMD});
|
||||
let emitter;
|
||||
const mockClient = {
|
||||
commandSocket: {
|
||||
pause: () => {},
|
||||
@@ -17,18 +19,23 @@ describe(CMD, function () {
|
||||
waitForConnection: () => Promise.resolve({
|
||||
resume: () => {}
|
||||
}),
|
||||
end: () => {}
|
||||
end: () => Promise.resolve({})
|
||||
}
|
||||
};
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.fs = {
|
||||
write: () => {}
|
||||
};
|
||||
|
||||
emitter = new EventEmitter();
|
||||
mockClient.emit = emitter.emit.bind(emitter);
|
||||
mockClient.on = emitter.on.bind(emitter);
|
||||
mockClient.once = emitter.once.bind(emitter);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
afterEach(() => sandbox.restore());
|
||||
@@ -72,4 +79,20 @@ describe(CMD, function () {
|
||||
expect(mockClient.reply.args[0][0]).to.equal(550);
|
||||
});
|
||||
});
|
||||
|
||||
it('// unsuccessful | emits error event', () => {
|
||||
sandbox.stub(mockClient.connector, 'waitForConnection').callsFake(function () {
|
||||
return Promise.reject(new Error('test'));
|
||||
});
|
||||
|
||||
let errorEmitted = false;
|
||||
emitter.once('STOR', err => {
|
||||
errorEmitted = !!err;
|
||||
});
|
||||
|
||||
return cmdFn({log, command: {arg: 'test.txt'}})
|
||||
.then(() => {
|
||||
expect(errorEmitted).to.equal(true);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -13,7 +13,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.fs = {
|
||||
get: () => Promise.resolve(),
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
});
|
||||
|
||||
@@ -11,7 +11,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
mockClient.transferType = null;
|
||||
sandbox.spy(mockClient, 'reply');
|
||||
|
||||
@@ -16,7 +16,7 @@ describe(CMD, function () {
|
||||
const cmdFn = require(`../../../src/commands/registration/${CMD.toLowerCase()}`).handler.bind(mockClient);
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
delete mockClient.username;
|
||||
mockClient.server.options = {};
|
||||
|
||||
@@ -6,9 +6,10 @@ const net = require('net');
|
||||
const tls = require('tls');
|
||||
|
||||
const ActiveConnector = require('../../src/connector/active');
|
||||
const findPort = require('../../src/helpers/find-port');
|
||||
const {getNextPortFactory} = require('../../src/helpers/find-port');
|
||||
|
||||
describe('Connector - Active //', function () {
|
||||
let getNextPort = getNextPortFactory(1024);
|
||||
let PORT;
|
||||
let active;
|
||||
let mockConnection = {};
|
||||
@@ -19,9 +20,9 @@ describe('Connector - Active //', function () {
|
||||
active = new ActiveConnector(mockConnection);
|
||||
});
|
||||
beforeEach(done => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
findPort()
|
||||
getNextPort()
|
||||
.then(port => {
|
||||
PORT = port;
|
||||
server = net.createServer()
|
||||
@@ -66,7 +67,11 @@ describe('Connector - Active //', function () {
|
||||
|
||||
it('upgrades to a secure connection', function () {
|
||||
mockConnection.secure = true;
|
||||
mockConnection.server = {_tls: {}};
|
||||
mockConnection.server = {
|
||||
options: {
|
||||
tls: {}
|
||||
}
|
||||
};
|
||||
|
||||
return active.setupConnection('127.0.0.1', PORT)
|
||||
.then(() => {
|
||||
|
||||
@@ -7,87 +7,117 @@ const net = require('net');
|
||||
const bunyan = require('bunyan');
|
||||
|
||||
const PassiveConnector = require('../../src/connector/passive');
|
||||
const {getNextPortFactory} = require('../../src/helpers/find-port');
|
||||
|
||||
describe('Connector - Passive //', function () {
|
||||
let passive;
|
||||
let mockConnection = {
|
||||
reply: () => Promise.resolve({}),
|
||||
close: () => Promise.resolve({}),
|
||||
encoding: 'utf8',
|
||||
log: bunyan.createLogger({name: 'passive-test'}),
|
||||
commandSocket: {},
|
||||
server: {options: {}}
|
||||
commandSocket: {
|
||||
remoteAddress: '::ffff:127.0.0.1'
|
||||
},
|
||||
server: {
|
||||
url: '',
|
||||
getNextPasvPort: getNextPortFactory(1024)
|
||||
}
|
||||
};
|
||||
let sandbox;
|
||||
|
||||
function shouldNotResolve() {
|
||||
throw new Error('Should not resolve');
|
||||
}
|
||||
|
||||
before(() => {
|
||||
passive = new PassiveConnector(mockConnection);
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
});
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox.spy(mockConnection, 'reply');
|
||||
sandbox.spy(mockConnection, 'close');
|
||||
|
||||
mockConnection.commandSocket.remoteAddress = '::ffff:127.0.0.1';
|
||||
mockConnection.server.options.pasv_range = '8000';
|
||||
});
|
||||
afterEach(() => {
|
||||
sandbox.restore();
|
||||
});
|
||||
|
||||
it('cannot wait for connection with no server', function () {
|
||||
return passive.waitForConnection()
|
||||
.then(shouldNotResolve)
|
||||
it('cannot wait for connection with no server', function (done) {
|
||||
let passive = new PassiveConnector(mockConnection);
|
||||
passive.waitForConnection()
|
||||
.catch(err => {
|
||||
expect(err.name).to.equal('ConnectorError');
|
||||
done();
|
||||
});
|
||||
});
|
||||
|
||||
it('no pasv range provided', function () {
|
||||
delete mockConnection.server.options.pasv_range;
|
||||
describe('setup', function () {
|
||||
before(function () {
|
||||
sandbox.stub(mockConnection.server, 'getNextPasvPort').value(getNextPortFactory());
|
||||
});
|
||||
|
||||
return passive.setupServer()
|
||||
.then(shouldNotResolve)
|
||||
.catch(err => {
|
||||
expect(err.name).to.equal('ConnectorError');
|
||||
it('no pasv range provided', function (done) {
|
||||
let passive = new PassiveConnector(mockConnection);
|
||||
passive.setupServer()
|
||||
.catch(err => {
|
||||
try {
|
||||
expect(err.name).to.equal('ConnectorError');
|
||||
done();
|
||||
} catch (ex) {
|
||||
done(ex);
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('has invalid pasv range', function () {
|
||||
mockConnection.server.options.pasv_range = -1;
|
||||
describe('setup', function () {
|
||||
let connection;
|
||||
before(function () {
|
||||
sandbox.stub(mockConnection.server, 'getNextPasvPort').value(getNextPortFactory(-1, -1));
|
||||
|
||||
return passive.setupServer()
|
||||
.then(shouldNotResolve)
|
||||
.catch(err => {
|
||||
expect(err.name).to.equal('RangeError');
|
||||
connection = new PassiveConnector(mockConnection);
|
||||
});
|
||||
|
||||
it('has invalid pasv range', function (done) {
|
||||
connection.setupServer()
|
||||
.catch(err => {
|
||||
expect(err.name).to.equal('ConnectorError');
|
||||
done();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('sets up a server', function () {
|
||||
let passive = new PassiveConnector(mockConnection);
|
||||
return passive.setupServer()
|
||||
.then(() => {
|
||||
expect(passive.dataServer).to.exist;
|
||||
return passive.end();
|
||||
});
|
||||
});
|
||||
|
||||
it('destroys existing server, then sets up a server', function () {
|
||||
const closeFnSpy = sandbox.spy(passive.dataServer, 'close');
|
||||
describe('setup', function () {
|
||||
let passive;
|
||||
let closeFnSpy;
|
||||
beforeEach(function () {
|
||||
passive = new PassiveConnector(mockConnection);
|
||||
return passive.setupServer()
|
||||
.then(() => {
|
||||
closeFnSpy = sandbox.spy(passive.dataServer, 'close');
|
||||
});
|
||||
});
|
||||
afterEach(function () {
|
||||
return passive.end();
|
||||
});
|
||||
|
||||
return passive.setupServer()
|
||||
.then(() => {
|
||||
expect(closeFnSpy.callCount).to.equal(1);
|
||||
expect(passive.dataServer).to.exist;
|
||||
it('destroys existing server, then sets up a server', function () {
|
||||
return passive.setupServer()
|
||||
.then(() => {
|
||||
expect(closeFnSpy.callCount).to.equal(2);
|
||||
expect(passive.dataServer).to.exist;
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
it('refuses connection with different remote address', function (done) {
|
||||
mockConnection.commandSocket.remoteAddress = 'bad';
|
||||
sandbox.stub(mockConnection.commandSocket, 'remoteAddress').value('bad');
|
||||
|
||||
let passive = new PassiveConnector(mockConnection);
|
||||
passive.setupServer()
|
||||
.then(() => {
|
||||
expect(passive.dataServer).to.exist;
|
||||
@@ -98,7 +128,9 @@ describe('Connector - Passive //', function () {
|
||||
setTimeout(() => {
|
||||
expect(passive.connection.reply.callCount).to.equal(1);
|
||||
expect(passive.connection.reply.args[0][0]).to.equal(550);
|
||||
done();
|
||||
|
||||
passive.end()
|
||||
.then(() => done());
|
||||
}, 100);
|
||||
});
|
||||
})
|
||||
@@ -106,6 +138,7 @@ describe('Connector - Passive //', function () {
|
||||
});
|
||||
|
||||
it('accepts connection', function () {
|
||||
let passive = new PassiveConnector(mockConnection);
|
||||
return passive.setupServer()
|
||||
.then(() => {
|
||||
expect(passive.dataServer).to.exist;
|
||||
|
||||
83
test/fs.spec.js
Normal file
83
test/fs.spec.js
Normal file
@@ -0,0 +1,83 @@
|
||||
const {expect} = require('chai');
|
||||
const nodePath = require('path');
|
||||
const Promise = require('bluebird');
|
||||
|
||||
const FileSystem = require('../src/fs');
|
||||
const errors = require('../src/errors');
|
||||
|
||||
describe('FileSystem', function () {
|
||||
let fs;
|
||||
|
||||
before(function () {
|
||||
fs = new FileSystem({}, {
|
||||
root: '/tmp/ftp-srv',
|
||||
cwd: 'file/1/2/3'
|
||||
});
|
||||
});
|
||||
|
||||
describe('extend', function () {
|
||||
class FileSystemOV extends FileSystem {
|
||||
chdir() {
|
||||
throw new errors.FileSystemError('Not a valid directory');
|
||||
}
|
||||
}
|
||||
let ovFs;
|
||||
before(function () {
|
||||
ovFs = new FileSystemOV({});
|
||||
});
|
||||
|
||||
it('handles error', function () {
|
||||
return Promise.try(() => ovFs.chdir())
|
||||
.catch(err => {
|
||||
expect(err).to.be.instanceof(errors.FileSystemError);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('#_resolvePath', function () {
|
||||
it('gets correct relative path', function () {
|
||||
const result = fs._resolvePath();
|
||||
expect(result).to.be.an('object');
|
||||
expect(result.clientPath).to.equal(
|
||||
nodePath.normalize('/file/1/2/3'));
|
||||
expect(result.fsPath).to.equal(
|
||||
nodePath.resolve('/tmp/ftp-srv/file/1/2/3'));
|
||||
});
|
||||
|
||||
it('gets correct relative path', function () {
|
||||
const result = fs._resolvePath('..');
|
||||
expect(result).to.be.an('object');
|
||||
expect(result.clientPath).to.equal(
|
||||
nodePath.normalize('/file/1/2'));
|
||||
expect(result.fsPath).to.equal(
|
||||
nodePath.resolve('/tmp/ftp-srv/file/1/2'));
|
||||
});
|
||||
|
||||
it('gets correct absolute path', function () {
|
||||
const result = fs._resolvePath('/other');
|
||||
expect(result).to.be.an('object');
|
||||
expect(result.clientPath).to.equal(
|
||||
nodePath.normalize('/other'));
|
||||
expect(result.fsPath).to.equal(
|
||||
nodePath.resolve('/tmp/ftp-srv/other'));
|
||||
});
|
||||
|
||||
it('cannot escape root', function () {
|
||||
const result = fs._resolvePath('../../../../../../../../../../..');
|
||||
expect(result).to.be.an('object');
|
||||
expect(result.clientPath).to.equal(
|
||||
nodePath.normalize('/'));
|
||||
expect(result.fsPath).to.equal(
|
||||
nodePath.resolve('/tmp/ftp-srv'));
|
||||
});
|
||||
|
||||
it('resolves to file', function () {
|
||||
const result = fs._resolvePath('/cool/file.txt');
|
||||
expect(result).to.be.an('object');
|
||||
expect(result.clientPath).to.equal(
|
||||
nodePath.normalize('/cool/file.txt'));
|
||||
expect(result.fsPath).to.equal(
|
||||
nodePath.resolve('/tmp/ftp-srv/cool/file.txt'));
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -1,9 +1,20 @@
|
||||
const {expect} = require('chai');
|
||||
const sinon = require('sinon');
|
||||
const moment = require('moment');
|
||||
|
||||
const fileStat = require('../../src/helpers/file-stat');
|
||||
const errors = require('../../src/errors');
|
||||
|
||||
describe('helpers // file-stat', function () {
|
||||
let sandbox;
|
||||
|
||||
before(function () {
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
});
|
||||
afterEach(function () {
|
||||
sandbox.restore();
|
||||
});
|
||||
|
||||
const STAT = {
|
||||
name: 'test1',
|
||||
dev: 2114,
|
||||
@@ -44,6 +55,11 @@ describe('helpers // file-stat', function () {
|
||||
|
||||
describe('format - ls //', function () {
|
||||
it('formats correctly', () => {
|
||||
const momentStub = sandbox.stub(moment, 'utc').callThrough();
|
||||
momentStub.onFirstCall().callsFake(function () {
|
||||
return moment.utc(new Date('Sept 10 2016'));
|
||||
});
|
||||
|
||||
const format = fileStat(STAT, 'ls');
|
||||
expect(format).to.equal('-rwxrwxrwx 1 85 100 527 Oct 10 23:24 test1');
|
||||
});
|
||||
|
||||
@@ -1,35 +1,52 @@
|
||||
/* eslint no-unused-expressions: 0 */
|
||||
const {expect} = require('chai');
|
||||
const {Server} = require('net');
|
||||
const net = require('net');
|
||||
const sinon = require('sinon');
|
||||
|
||||
const findPort = require('../../src/helpers/find-port');
|
||||
const {getNextPortFactory} = require('../../src/helpers/find-port');
|
||||
|
||||
describe('helpers // find-port', function () {
|
||||
let sandbox;
|
||||
let getNextPort;
|
||||
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
|
||||
sandbox.spy(Server.prototype, 'listen');
|
||||
getNextPort = getNextPortFactory(1, 2);
|
||||
});
|
||||
afterEach(() => {
|
||||
sandbox.restore();
|
||||
});
|
||||
|
||||
it('finds a port', () => {
|
||||
return findPort(1)
|
||||
sandbox.stub(net.Server.prototype, 'listen').callsFake(function (port) {
|
||||
this.address = () => ({port});
|
||||
setImmediate(() => this.emit('listening'));
|
||||
});
|
||||
|
||||
return getNextPort()
|
||||
.then(port => {
|
||||
expect(Server.prototype.listen.callCount).to.be.above(1);
|
||||
expect(port).to.be.above(1);
|
||||
expect(port).to.equal(1);
|
||||
});
|
||||
});
|
||||
|
||||
it('does not find a port', () => {
|
||||
return findPort(1, 2)
|
||||
.then(() => expect(1).to.equal(2)) // should not happen
|
||||
.catch(err => {
|
||||
expect(err).to.exist;
|
||||
it('restarts count', () => {
|
||||
sandbox.stub(net.Server.prototype, 'listen').callsFake(function (port) {
|
||||
this.address = () => ({port});
|
||||
setImmediate(() => this.emit('listening'));
|
||||
});
|
||||
|
||||
return getNextPort()
|
||||
.then(port => {
|
||||
expect(port).to.equal(1);
|
||||
})
|
||||
.then(() => getNextPort())
|
||||
.then(port => {
|
||||
expect(port).to.equal(2);
|
||||
})
|
||||
.then(() => getNextPort())
|
||||
.then(port => {
|
||||
expect(port).to.equal(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
@@ -7,7 +7,7 @@ describe('helpers //resolve-host', function () {
|
||||
|
||||
let sandbox;
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
});
|
||||
afterEach(() => sandbox.restore());
|
||||
|
||||
|
||||
@@ -22,10 +22,10 @@ describe('Integration', function () {
|
||||
const clientDirectory = `${process.cwd()}/test_tmp`;
|
||||
|
||||
before(() => {
|
||||
return startServer('ftp://127.0.0.1:8880');
|
||||
return startServer({url: 'ftp://127.0.0.1:8880'});
|
||||
});
|
||||
beforeEach(() => {
|
||||
sandbox = sinon.sandbox.create();
|
||||
sandbox = sinon.sandbox.create().usingPromise(Promise);
|
||||
});
|
||||
afterEach(() => sandbox.restore());
|
||||
after(() => server.close());
|
||||
@@ -36,10 +36,19 @@ describe('Integration', function () {
|
||||
});
|
||||
after(() => directoryPurge(clientDirectory));
|
||||
|
||||
function startServer(url, options = {}) {
|
||||
server = new FtpServer(url, _.assign({
|
||||
function readFile(path) {
|
||||
return new Promise((resolve, reject) => {
|
||||
fs.readFile(path, 'utf8', (err, data) => {
|
||||
if (err) reject(err);
|
||||
else resolve(data);
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
function startServer(options = {}) {
|
||||
server = new FtpServer(_.assign({
|
||||
log,
|
||||
pasv_range: 8881,
|
||||
pasv_min: 8881,
|
||||
greeting: ['hello', 'world'],
|
||||
anonymous: true
|
||||
}, options));
|
||||
@@ -172,12 +181,12 @@ describe('Integration', function () {
|
||||
const stream = fs.createWriteStream(fsPath, {flags: 'w+'});
|
||||
stream.on('error', () => fs.existsSync(fsPath) && fs.unlinkSync(fsPath));
|
||||
stream.on('close', () => stream.end());
|
||||
setTimeout(() => stream.emit('error', new Error('STOR fail test')));
|
||||
setImmediate(() => stream.emit('error', new Error('STOR fail test')));
|
||||
return stream;
|
||||
});
|
||||
|
||||
client.put(buffer, 'fail.txt', err => {
|
||||
setTimeout(() => {
|
||||
setImmediate(() => {
|
||||
const fileExists = fs.existsSync(fsPath);
|
||||
expect(err).to.exist;
|
||||
expect(fileExists).to.equal(false);
|
||||
@@ -189,9 +198,14 @@ describe('Integration', function () {
|
||||
it('STOR tést.txt', done => {
|
||||
const buffer = Buffer.from('test text file');
|
||||
const fsPath = `${clientDirectory}/${name}/tést.txt`;
|
||||
|
||||
connection.once('STOR', err => {
|
||||
expect(err).to.not.exist;
|
||||
});
|
||||
|
||||
client.put(buffer, 'tést.txt', err => {
|
||||
expect(err).to.not.exist;
|
||||
setTimeout(() => {
|
||||
setImmediate(() => {
|
||||
expect(fs.existsSync(fsPath)).to.equal(true);
|
||||
fs.readFile(fsPath, (fserr, data) => {
|
||||
expect(fserr).to.not.exist;
|
||||
@@ -207,7 +221,7 @@ describe('Integration', function () {
|
||||
const fsPath = `${clientDirectory}/${name}/tést.txt`;
|
||||
client.append(buffer, 'tést.txt', err => {
|
||||
expect(err).to.not.exist;
|
||||
setTimeout(() => {
|
||||
setImmediate(() => {
|
||||
expect(fs.existsSync(fsPath)).to.equal(true);
|
||||
fs.readFile(fsPath, (fserr, data) => {
|
||||
expect(fserr).to.not.exist;
|
||||
@@ -219,6 +233,10 @@ describe('Integration', function () {
|
||||
});
|
||||
|
||||
it('RETR tést.txt', done => {
|
||||
connection.once('RETR', err => {
|
||||
expect(err).to.not.exist;
|
||||
});
|
||||
|
||||
client.get('tést.txt', (err, stream) => {
|
||||
expect(err).to.not.exist;
|
||||
let text = '';
|
||||
@@ -376,15 +394,17 @@ describe('Integration', function () {
|
||||
runFileSystemTests('binary');
|
||||
});
|
||||
|
||||
describe.skip('#EXPLICIT', function () {
|
||||
describe('#EXPLICIT', function () {
|
||||
before(() => {
|
||||
return server.close()
|
||||
.then(() => startServer('ftp://127.0.0.1:8880', {
|
||||
tls: {
|
||||
key: `${process.cwd()}/test/cert/server.key`,
|
||||
cert: `${process.cwd()}/test/cert/server.crt`,
|
||||
ca: `${process.cwd()}/test/cert/server.csr`
|
||||
}
|
||||
.then(() => Promise.all([
|
||||
readFile(`${process.cwd()}/test/cert/server.key`),
|
||||
readFile(`${process.cwd()}/test/cert/server.crt`),
|
||||
readFile(`${process.cwd()}/test/cert/server.csr`)
|
||||
]))
|
||||
.then(([key, cert, ca]) => startServer({
|
||||
url: 'ftp://127.0.0.1:8880',
|
||||
tls: {key, cert, ca}
|
||||
}))
|
||||
.then(() => {
|
||||
return connectClient({
|
||||
@@ -405,12 +425,14 @@ describe('Integration', function () {
|
||||
describe.skip('#IMPLICIT', function () {
|
||||
before(() => {
|
||||
return server.close()
|
||||
.then(() => startServer('ftps://127.0.0.1:8880', {
|
||||
tls: {
|
||||
key: `${process.cwd()}/test/cert/server.key`,
|
||||
cert: `${process.cwd()}/test/cert/server.crt`,
|
||||
ca: `${process.cwd()}/test/cert/server.csr`
|
||||
}
|
||||
.then(() => Promise.all([
|
||||
readFile(`${process.cwd()}/test/cert/server.key`),
|
||||
readFile(`${process.cwd()}/test/cert/server.crt`),
|
||||
readFile(`${process.cwd()}/test/cert/server.csr`)
|
||||
]))
|
||||
.then(([key, cert, ca]) => startServer({
|
||||
url: 'ftps://127.0.0.1:8880',
|
||||
tls: {key, cert, ca}
|
||||
}))
|
||||
.then(() => {
|
||||
return connectClient({
|
||||
|
||||
@@ -1,5 +0,0 @@
|
||||
{
|
||||
"mute":false,
|
||||
"level":"debug",
|
||||
"reporter":"spec"
|
||||
}
|
||||
@@ -1,18 +1,17 @@
|
||||
require('dotenv').load();
|
||||
const bunyan = require('bunyan');
|
||||
|
||||
const fs = require('fs');
|
||||
const FtpServer = require('../src');
|
||||
|
||||
const log = bunyan.createLogger({name: 'test'});
|
||||
log.level('trace');
|
||||
const server = new FtpServer('ftp://127.0.0.1:8880', {
|
||||
log,
|
||||
pasv_range: 8881,
|
||||
const server = new FtpServer({
|
||||
log: bunyan.createLogger({name: 'test', level: 'trace'}),
|
||||
url: 'ftps://127.0.0.1:8880',
|
||||
pasv_min: 8881,
|
||||
greeting: ['Welcome', 'to', 'the', 'jungle!'],
|
||||
tls: {
|
||||
key: `${process.cwd()}/test/cert/server.key`,
|
||||
cert: `${process.cwd()}/test/cert/server.crt`,
|
||||
ca: `${process.cwd()}/test/cert/server.csr`
|
||||
key: fs.readFileSync(`${process.cwd()}/test/cert/server.key`),
|
||||
cert: fs.readFileSync(`${process.cwd()}/test/cert/server.crt`),
|
||||
ca: fs.readFileSync(`${process.cwd()}/test/cert/server.csr`)
|
||||
},
|
||||
file_format: 'ep',
|
||||
anonymous: 'sillyrabbit'
|
||||
|
||||
Reference in New Issue
Block a user