{"id":238334,"date":"2022-05-20T08:30:00","date_gmt":"2022-05-20T12:30:00","guid":{"rendered":"https:\/\/wordpress-756359-3782526.cloudwaysapps.com\/?p=238334"},"modified":"2025-05-30T07:26:40","modified_gmt":"2025-05-30T07:26:40","slug":"22-05-20-nyc","status":"publish","type":"post","link":"https:\/\/www.travis-ci.com\/blog\/22-05-20-nyc\/","title":{"rendered":"Nyc and Istanbul Integration with Travis"},"content":{"rendered":"\n

Nyc is a command line tool for instrumenting code with Istanbul coverage (the successor to the istanbul command line tool). Let\u2019s see how we can\u2019t integrate nyc into our build and try it out!<\/p>\n\n\n\n

How Istanbul works<\/h2>\n\n\n\n

Istanbul instruments your ES5 and ES2015+ JavaScript code with line counters, so that you can track how well your unit-tests exercise your codebase.<\/p>\n\n\n\n

How nyc works<\/h2>\n\n\n\n

The nyc<\/code> command-line-client for Istanbul works well with most JavaScript testing frameworks: tap, mocha, AVA, etc. nyc<\/code> is a command line tool for instrumenting code with Istanbul coverage (the successor to the istanbul command line tool). For more information go to Istanbul\u2019s website: https:\/\/istanbul.js.org\/integrations\/ and click the nyc<\/code> integration:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Now that we have a fairly broad understanding of what nyc<\/code> is and Istanbul is, let\u2019s get onto using it.<\/p>\n\n\n\n

Usage<\/h2>\n\n\n\n

Somethings you\u2019ll need to get started and to run this successfully on Travis are: Mongo<\/code>, Express<\/code>, Mocha<\/code>, Chai<\/code> and Jasmine<\/code>. You can grab these using npm install -g<\/code>. Now first clone my repo:<\/p>\n\n\n\n

git clone https:\/\/github.com\/Montana\/travis-nyc.git<\/code><\/pre>\n\n\n\n
You\u2019ll see under Mongoose these three variables in app.js<\/code>:<\/p>\n\n\n\n
 useNewUrlParser: true,\n useCreateIndex: true,\n useFindAndModify: false<\/code><\/pre>\n\n\n\n
Remove them. Now use your package manager (yarn, npm) to add it as a dev dependency: npm i -D nyc<\/code> or yarn add -D nyc<\/code>. You can use nyc<\/code> to call npm<\/code> scripts (assuming they don\u2019t already have nyc<\/code> executed in them), if that\u2019s the case you\u2019ll have to replace your test runners with Mocha:<\/p>\n\n\n\n
{\n  \"scripts\": {\n    \"test\": \"mocha\",\n    \"coverage\": \"nyc npm run test\"\n  }\n}<\/code><\/pre>\n\n\n\n
Enforcing overrides in nyc and Istanbul<\/h2>\n\n\n\n
The great thing about nyc<\/code> is that it allows you to inherit other configurations, that said, you can already imagine the flexibility. Using the key extends in the package.json<\/code> stanza, .nycrc<\/code>, or YAML files. You can then add the specific configuration options you want that aren\u2019t in that particular shared configuration:<\/p>\n\n\n\n
{\n  \"extends\": \"@istanbuljs\/nyc-config-typescript\",\n  \"all\": true,\n  \"check-coverage\": true\n}<\/code><\/pre>\n\n\n\n
Now let\u2019s get to an up and running demo!<\/p>\n\n\n\n
MongoDB<\/h2>\n\n\n\n
Fetch MongoDB, in your .travis.yml<\/code> file under the script:<\/code> hook, do:<\/p>\n\n\n\n
- wget -qO - https:\/\/www.mongodb.org\/static\/pgp\/server-5.0.asc | sudo apt-key add -\n  - sudo apt-get install -y mongodb-org<\/code><\/pre>\n\n\n\n
You clearly see we are fetching Mongo\u2019s apt-key<\/code>\u2019s and then using apt-get<\/code> to finish off the install, make sure you have gnupg<\/code> installed as well you can do that by doing:<\/p>\n\n\n\n
sudo apt-get install gnupg<\/code><\/pre>\n\n\n\n
Installing nyc and connecting to Mongo with mock credentials<\/h2>\n\n\n\n
You\u2019ll want to run the following in your project root:<\/p>\n\n\n\n
npm init --yes\nnpm i express mocha chai supertest nyc mongoose<\/code><\/pre>\n\n\n\n
Depending on your version of node, you may have to run:<\/p>\n\n\n\n
npm install -g nyc<\/code><\/pre>\n\n\n\n
For nyc<\/code> to install completely. Let\u2019s now connect our app to our mock Mongo server:<\/p>\n\n\n\n
sudo systemctl start mongo<\/code><\/pre>\n\n\n\n
Now that we are connected, let\u2019s run our app:<\/p>\n\n\n\n
node bin\/www & <\/code><\/pre>\n\n\n\n
The .travis.yml<\/code> file<\/h2>\n\n\n\n
This is how my final .travis.yml<\/code> file came out after I was done creating it:<\/p>\n\n\n\n
services:\n  - docker\nlanguage: node_js\nnode_js:\n  - 17\nscript: \n  - npm init --yes\n  - npm i express mocha chai supertest nyc mongoose\n  - sudo apt-get install gnupg\n  - wget -qO - https:\/\/www.mongodb.org\/static\/pgp\/server-5.0.asc | sudo apt-key add -\n  - sudo apt-get install -y mongodb-org\n  - sudo systemctl start mongod\n  - node bin\/www & \n  - npm install -g nyc\n  - nyc npm run test<\/code><\/pre>\n\n\n\n
We call on Docker for services, we are going to use Node version 17, and also start installing the nyc<\/code> packages, and you kind of see how the rest progresses. Important to have &<\/code> after node bin\/www<\/code> or your build will get stuck in Travis, this tells Travis to have it run as a background process.<\/em><\/p>\n\n\n\n
Now you\u2019ll see this (or something similar) if nyc<\/code> was ran successfully in Travis:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Testing with nyc<\/h2>\n\n\n\n
Now, time to test your project with nyc<\/code>, lets run:<\/p>\n\n\n\n
nyc npm run test<\/code><\/pre>\n\n\n\n
If it\u2019s successful you should see this in Travis:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
If you run it locally, you can get a GUI version of what you\u2019re seeing in the Travis build, which looks like this:<\/p>\n\n\n\n
\"\"<\/figure>\n\n\n\n
Conclusion<\/h2>\n\n\n\n
This is the simplest way to use nyc<\/code> and Travis together. This was made by myself (Montana Mendy) and as per usual if you have any questions please email me at montana@travis-ci.org<\/a>.<\/p>\n\n\n\n
Happy building!<\/p>\n","protected":false},"excerpt":{"rendered":"
Nyc is a command line tool for instrumenting code with Istanbul coverage (the successor to the istanbul command line tool). Let\u2019s see how we can\u2019t integrate nyc into our build and try it out! How Istanbul works Istanbul instruments your ES5 and ES2015+ JavaScript code with line counters, so that you can track how well […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_breakdance_hide_in_design_set":false,"_breakdance_tags":"","footnotes":""},"categories":[16],"tags":[7,19,20,5],"class_list":["post-238334","post","type-post","status-publish","format-standard","hentry","category-news","tag-community","tag-feature","tag-infrastructure","tag-news"],"_links":{"self":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts\/238334","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/comments?post=238334"}],"version-history":[{"count":3,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts\/238334\/revisions"}],"predecessor-version":[{"id":242768,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts\/238334\/revisions\/242768"}],"wp:attachment":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/media?parent=238334"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/categories?post=238334"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/tags?post=238334"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}