Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Run tests e2e against an npm pack && npm installed ts-node #1032

Merged
merged 6 commits into from
May 11, 2020
Merged

Run tests e2e against an npm pack && npm installed ts-node #1032

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
95cb9bc
Tweak tests to run against packed and installed ts-node instead of lo…
cspotcode May 10, 2020
f82c7f5
avoid re-building when packing
cspotcode May 10, 2020
2869699
fix for node 6
cspotcode May 10, 2020
1bbc7cd
move npm pack into build step
cspotcode May 10, 2020
e7d1ffb
Merge remote-tracking branch 'origin/master' into ab/e2e-tests
cspotcode May 10, 2020
b56dfde
update package-lock
cspotcode May 10, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@
"tslint": "^6.1.0",
"tslint-config-standard": "^9.0.0",
"typescript": "^3.7.2",
"typescript-json-schema": "^0.42.0"
"typescript-json-schema": "^0.42.0",
"util.promisify": "^1.0.1"
},
"peerDependencies": {
"typescript": ">=2.7"
Expand Down
4 changes: 4 additions & 0 deletions src/externs.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
declare module 'util.promisify' {
const _export: typeof import('util').promisify
export = _export
}
34 changes: 27 additions & 7 deletions src/index.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,36 @@ import semver = require('semver')
import ts = require('typescript')
import proxyquire = require('proxyquire')
import { register, create, VERSION } from './index'
import { mkdtempSync, readdirSync, copyFileSync, rmdirSync, unlinkSync, existsSync, readFileSync, writeFileSync } from 'fs'
import * as promisify from 'util.promisify'

const execP = promisify(exec)

const ROOT_DIR = join(__dirname, '..')
const TEST_DIR = join(__dirname, '../tests')
const TARBALL_PATH = join(TEST_DIR, 'ts-node-packed.tgz')
const PROJECT = join(TEST_DIR, 'tsconfig.json')
const BIN_PATH = join(__dirname, '../dist/bin')
const BIN_SCRIPT_PATH = join(__dirname, '../dist/bin-script')
const BIN_PATH = join(TEST_DIR, 'node_modules/.bin/ts-node')
const BIN_SCRIPT_PATH = join(TEST_DIR, 'node_modules/.bin/ts-node-script')

const SOURCE_MAP_REGEXP = /\/\/# sourceMappingURL=data:application\/json;charset=utf\-8;base64,[\w\+]+=*$/

// Pack and install ts-node locally, necessary to test package "exports"
before(async function () {
this.timeout(30000)
const tempDir = mkdtempSync(join(TEST_DIR, 'tmp'))
await execP(`npm pack --ignore-scripts "${ROOT_DIR}"`, { cwd: tempDir })
const tarballPath = join(tempDir, readdirSync(tempDir)[0])
writeFileSync(TARBALL_PATH, readFileSync(tarballPath))
unlinkSync(tarballPath)
rmdirSync(tempDir)
await execP(`npm install`, { cwd: TEST_DIR })
const packageLockPath = join(TEST_DIR, 'package-lock.json')
existsSync(packageLockPath) && unlinkSync(packageLockPath)
})
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if these a way to do this outside of the test suite or possibly a separate set of tests? Either way this looks like a great start at coverage.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can definitely move the npm pack into our npm build. That would be better since it would npm pack using the same node and npm versions as we use to publish.

Are you thinking you want 2x sets of tests, one unit tests, the other doing these e2e-style tests against an npm install?

I thought about that but I wasn't sure how useful it'd be since the tests mostly look e2e-style already. Your call though, happy to split things out.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep it how it is then, I don't have strong opinions either way but it's great to know you thought about this.


describe('ts-node', function () {
const cmd = `node "${BIN_PATH}" --project "${PROJECT}"`
const cmd = `"${BIN_PATH}" --project "${PROJECT}"`

this.timeout(10000)

Expand All @@ -35,7 +55,7 @@ describe('ts-node', function () {
})

it('should register via cli', function (done) {
exec(`node -r ../register hello-world.ts`, {
exec(`node -r ts-node/register hello-world.ts`, {
cwd: TEST_DIR
}, function (err, stdout) {
expect(err).to.equal(null)
Expand Down Expand Up @@ -73,7 +93,7 @@ describe('ts-node', function () {
})

it('should provide registered information on register', function (done) {
exec(`node -r ../register env.ts`, {
exec(`node -r ts-node/register env.ts`, {
cwd: TEST_DIR
}, function (err, stdout) {
expect(err).to.equal(null)
Expand Down Expand Up @@ -408,7 +428,7 @@ describe('ts-node', function () {
}

describe('should read ts-node options from tsconfig.json', function () {
const BIN_EXEC = `node "${join(__dirname, '../dist/bin')}" --project tests/tsconfig-options/tsconfig.json`
const BIN_EXEC = `"${BIN_PATH}" --project tests/tsconfig-options/tsconfig.json`

it('should override compiler options from env', function (done) {
exec(`${BIN_EXEC} tests/tsconfig-options/log-options.js`, {
Expand Down Expand Up @@ -481,7 +501,7 @@ describe('ts-node', function () {
})

it('should give ts error for invalid node_modules', function (done) {
exec(`${cmd} --compiler-host --skip-ignore tests/from-node-modules`, function (err, stdout) {
exec(`${cmd} --compiler-host --skip-ignore tests/from-node-modules/from-node-modules`, function (err, stdout) {
if (err === null) return done('Expected an error')

expect(err.message).to.contain('Unable to compile file from external library')
Expand Down
4 changes: 3 additions & 1 deletion tests/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
!node_modules/
!from-node-modules/node_modules/
package-lock.json
ts-node-packed.tgz
0 tests/from-node-modules.ts → tests/from-node-modules/from-node-modules.ts
View file
Open in desktop
File renamed without changes.
0 tests/node_modules/test.ts → tests/from-node-modules/node_modules/test.ts
View file
Open in desktop
File renamed without changes.
5 changes: 5 additions & 0 deletions tests/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"ts-node": "file:ts-node-packed.tgz"
}
}