{"_id":"@abhijoseph/newman-reporter-reportportal","_rev":"4-a616eaf2a89e77a63fc538c4a62aa679","name":"@abhijoseph/newman-reporter-reportportal","dist-tags":{"latest":"0.0.26"},"versions":{"0.0.25":{"name":"@abhijoseph/newman-reporter-reportportal","version":"0.0.25","description":"Reportportal reporter for newman","keywords":["postman","newman","epam"],"homepage":"https://github.com/abhilashjoseph/agent-postman","main":"index","author":{"name":"Ilya Koshaleu"},"license":"Apache-2.0","scripts":{"lint":"eslint ./lib --quiet --fix"},"repository":{"type":"git","url":"git+https://github.com/abhilashjoseph/agent-postman.git"},"dependencies":{"lodash":"^4.17.15","@abhijoseph/reportportal-client":"^5.2.4","string_decoder":"^1.2.0"},"devDependencies":{"eslint":"^5.16.0","eslint-plugin-jsdoc":"^4.8.1","eslint-plugin-lodash":"^5.1.0"},"bugs":{"url":"https://github.com/reportportal/agent-postman/issues"},"directories":{"lib":"lib"},"gitHead":"f2045cb744664a98dec8f84c3009736e49a2e9f2","_id":"@abhijoseph/newman-reporter-reportportal@0.0.25","_nodeVersion":"10.16.1","_npmVersion":"6.9.0","dist":{"integrity":"sha512-kCErdvgomJYxErNgifZ2dtHaMdtK6ePnPNnhmYt8lQLOFaAX8Qk5K59skVvWVIfxqIS6kyk0O7zUD+0FC3KAZg==","shasum":"c88e0ec5f5d76d6b2ac723b07dfb24aed45e4af3","tarball":"https://registry.npmjs.org/@abhijoseph/newman-reporter-reportportal/-/newman-reporter-reportportal-0.0.25.tgz","fileCount":12,"unpackedSize":80374,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdnQsOCRA9TVsSAnZWagAAGeEP/AqvG2OPHFpRYgxZof/u\n7XKUBzR6dKkizyulje1mYGxcdtc1a38TobP+jgyikEA2p2wJA4SYivk0c+9M\n+heKmfjbTing5q2anGmE94qxXa+vpSCClrumD3+yH2/CMgRosiHdTppbaXXi\nJXPYSxAtkVYKOjFJRvk/loQ5ZAkQRDGxADPUZbhCp4xStBi+Bwrhvpb5SGZM\nPECK3X1yKEXM3AzvyuxALGnlVAFifkeY8ZDo6ouCCyDeKY9JfNScE7L0dArM\nPXek2Ym7T5MWq6l6hqBRpDuqZEwVdB0nlN9cbI/DxROKt/Q3eDPGwQGYorJU\ndnGZ3IVtg1o+BAa6M8pqRNYOrFCswHv/gbq7lWjWDvc766LX+vJtecjqQQv4\nV4nXockxXFDOFcC3mSngr254vtw+Oel1O/FGloq1qAumYrBaEo0MLSzR+ycU\nXNHvx48OsiVoyHqj2vjwgBkknsSgEn/HnuYFnIsVGZbo2MseDz4eghAQP3SU\niQrRNmAhXV2bVIuDohvnr6JaDxKKgQy9kqidzrwBMQt+xkvc1pNp9vEO7D1E\n5KzQOjB79xrRpCywYMy3RlA0mbXF2HHdPFRus9jKkVjjA8NtJoA21Bh6f+hh\nM/2SYyt16L2lSXAkbWqhBmXymf4MO/8Zbzxj/3FUUkA3lM/p+xIlEkkXl4lQ\neJG+\r\n=aBfq\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHcYqRMhgLv8iJPxMfY+O2VHq2EUtP2h5PpNdS2O+PknAiAhxuCWUBQCAiQUx9DGnbsLMEkbYkR15AgFnJ8rUY+O8w=="}]},"maintainers":[{"name":"abhijoseph","email":"abhijoseph@gmail.com"}],"_npmUser":{"name":"abhijoseph","email":"abhijoseph@gmail.com"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/newman-reporter-reportportal_0.0.25_1570573070164_0.8027305462556382"},"_hasShrinkwrap":false},"0.0.26":{"name":"@abhijoseph/newman-reporter-reportportal","version":"0.0.26","description":"Reportportal reporter for newman","keywords":["postman","newman","epam"],"homepage":"https://github.com/abhilashjoseph/agent-postman","main":"index","author":{"name":"Ilya Koshaleu"},"license":"Apache-2.0","scripts":{"lint":"eslint ./lib --quiet --fix"},"repository":{"type":"git","url":"git+https://github.com/abhilashjoseph/agent-postman.git"},"dependencies":{"lodash":"^4.17.15","reportportal-client-cer":"^5.2.5","string_decoder":"^1.2.0"},"devDependencies":{"eslint":"^5.16.0","eslint-plugin-jsdoc":"^4.8.1","eslint-plugin-lodash":"^5.1.0"},"bugs":{"url":"https://github.com/reportportal/agent-postman/issues"},"directories":{"lib":"lib"},"gitHead":"dbdb315a29beeee868f0e8cca94c9388f526d866","_id":"@abhijoseph/newman-reporter-reportportal@0.0.26","_nodeVersion":"10.16.1","_npmVersion":"6.9.0","dist":{"integrity":"sha512-TcnBDkTGNeglUGhB0WMrXG2AiR3uddxnBesdR3WNFZd+jUQf77CfpB4tpCz3O7JTPP6PJXyoeROGi6kir1ovHQ==","shasum":"07e46222e8491fb961ca3c587822f26f4755748e","tarball":"https://registry.npmjs.org/@abhijoseph/newman-reporter-reportportal/-/newman-reporter-reportportal-0.0.26.tgz","fileCount":12,"unpackedSize":80390,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdnd5RCRA9TVsSAnZWagAAU8IP/2RfwIzdnALO9sW9XZat\n97nuK9kX2mPc0fjyBoNa+YIQRzb6J1BhPavdfn7zATgGuPymBcdLppE5BiKb\nnakCuWzubP1bAMu+IQgzhVBnQ7GhsTK5rQXggwDilFGwgAW87UHHvArU/jop\nl11qUeJvFlcYVB+zS0E+OLqRcppNbeKGDGxh1XlYKkOutDEzyMq1CJFfIBaV\nNv4W1Br2ikRlxqJxKpwSUDc6ez6V8iOq0B4ZwmhBGw8KpbWlJc1gd6fH0Q0o\nD0Ky44NSn7zG2C77/J1xYo6nFe+rW9nHNJdMbcBrv8voQNWIpl7TEUrfXBGV\nhqeOWpm37MdYlIoLOsNjjalPB7+teauukqNqFLm3GHwBT3KonYJMBLmu3Ry/\negDMywDxovV8NiRhtDoYqWu+acDP8jmDgTyiFhlYtz7zIznHlCs2OBe72VLt\nA8It+nWe6F9K+mYdiz115g4OX472HYhauBpJCc+MySzig0Fa3dcmWhbL3WGn\ndAIedb/LlGudb9KMb5bym846o91TKd1jD15/yvd/rcBd7wqvzZ5VExWb8DVf\nf8uTzX7u3A9N+p0y7fgtq3afI4UrAw9Q6/h1LPddEKpVLlXHNPEM4+jmarzm\nlPJSEdTMcinnzxgPHaB+XA+je3107DTDpfP0Yfky7v0KgtUcN7jrEIWxgh4P\nHeyn\r\n=tfe4\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFQO/DoB8BmeDGe4ZW30oMge/h5CaG4NCqYiwRhFeFESAiEAus0EQloyFSQoC4KCugLodEigGnjYQSRqe3rG8InvuMM="}]},"maintainers":[{"name":"abhijoseph","email":"abhijoseph@gmail.com"}],"_npmUser":{"name":"abhijoseph","email":"abhijoseph@gmail.com"},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/newman-reporter-reportportal_0.0.26_1570627152322_0.3137177281304573"},"_hasShrinkwrap":false}},"time":{"created":"2019-10-08T16:59:06.217Z","0.0.24":"2019-10-08T16:59:06.576Z","modified":"2022-04-04T10:59:16.404Z","0.0.25":"2019-10-08T22:17:50.270Z","0.0.26":"2019-10-09T13:19:12.511Z"},"maintainers":[{"name":"abhijoseph","email":"abhijoseph@gmail.com"}],"description":"Reportportal reporter for newman","homepage":"https://github.com/abhilashjoseph/agent-postman","keywords":["postman","newman","epam"],"repository":{"type":"git","url":"git+https://github.com/abhilashjoseph/agent-postman.git"},"author":{"name":"Ilya Koshaleu"},"bugs":{"url":"https://github.com/reportportal/agent-postman/issues"},"license":"Apache-2.0","readme":"# newman-reporter-reportportal\r\n\r\nNewman runtime reporter for [EPAM report portal](https://github.com/reportportal/reportportal) which provides information about collection run.\r\n\r\n## Install\r\n\r\nThe installation should be global if newman is installed globally, otherwise - local (replace -g from the command below with -S for a local installation).\r\n\r\n```bash\r\n$ npm install -g @reportportal/newman-reporter-reportportal\r\n```\r\n\r\n## Usage\r\n\r\nThere are two ways to enable this reporter - with command line or programmatically.\r\n\r\n#### With CLI\r\n\r\nTo enable this reporter you have to specify `reportportal` in Newman's `-r` or `--reporters` option.\r\n\r\n```bash\r\n$ newman run https://postman-echo.com/status/200 \\\r\n -r @reportportal/reportportal \\\r\n --reporter-@reportportal/reportportal-debug=true \\\r\n --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \\\r\n --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \\\r\n --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \\\r\n --reporter-@reportportal/reportportal-project=PROJECT_NAME \\\r\n -x\r\n```\r\n\r\nPay attention that you **must** add **-x** or **--suppress-exit-code** parameter while running newman using CLI.\r\n\r\n#### Programmatically\r\n\r\n```javascript\r\nconst newman = require(\"newman\");\r\n\r\nnewman.run(\r\n {\r\n collection: \"./collections/newman-test_collection.json\",\r\n reporters: \"@reportportal/reportportal\",\r\n reporter: {\r\n \"@reportportal/reportportal\": {\r\n debug: true,\r\n endpoint: \"http://your-instance.com:8080/api/v1\",\r\n token: \"00000000-0000-0000-0000-000000000000\",\r\n launch: \"LAUNCH_NAME\",\r\n project: \"PROJECT_NAME\"\r\n }\r\n }\r\n },\r\n function(err) {\r\n if (err) {\r\n throw err;\r\n }\r\n console.log(\"collection run complete!\");\r\n }\r\n);\r\n```\r\n\r\n#### Options\r\n\r\nBoth CLI and programmatic runs support following options:\r\n\r\n| Parameter | Description |\r\n| --------- | ----------------------------------------------------------------------------------------------------------------- |\r\n| token | User's Report Portal toke from which you want to send requests. It can be found on the profile page of this user. |\r\n| endpoint | URL of your server. For example 'https://server:8080/api/v1'. |\r\n| launch | Name of launch at creation. |\r\n| project | The name of the project in which the launches will be created. |\r\n| debug | Determines whether newman's run should be logged in details. |\r\n\r\n## Docker\r\n\r\nThis reporter can also be used inside of a docker container.\r\n\r\n### Using existing image\r\n\r\nThe docker image for this reporter is available for download from our docker hub. So, first of all you have to ensure that you have docker installed and running in your system. Otherwise, see installation guideline for\r\nyou operating systems.\r\n\r\n#### Step 1\r\n\r\nPull the newman docker image with installed reporter from docker hub:\r\n\r\n```console\r\n$ docker pull reportportal/newman\r\n```\r\n\r\n#### Step 2\r\n\r\nRun newman commands on the image:\r\n\r\n```bash\r\n$ docker run -t reportportal/newman run https://www.getpostman.com/collections/8a0c9bc08f062d12dcda \\\r\n -r @reportportal/reportportal \\\r\n --reporter-@reportportal/reportportal-debug=true \\\r\n --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \\\r\n --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \\\r\n --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \\\r\n --reporter-@reportportal/reportportal-project=PROJECT_NAME \\\r\n -x\r\n```\r\n\r\nIf you want to use this reporter for a specific collection JSON file, you have to mount a directory with this file:\r\n\r\n```bash\r\n$ docker run -v ~/collections:/etc/newman -t reportportal/newman run \"example_postman-collection.json\" \\\r\n -r @reportportal/reportportal \\\r\n --reporter-@reportportal/reportportal-debug=true \\\r\n --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \\\r\n --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \\\r\n --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \\\r\n --reporter-@reportportal/reportportal-project=PROJECT_NAME \\\r\n -x\r\n```\r\n\r\n### Build the docker image from this repository\r\n\r\n**Step 1:**\r\n\r\nClone this repository:\r\n\r\n```bash\r\n$ git clone https://github.com/reportportal/agent-postman\r\n```\r\n\r\n**Step 2:**\r\n\r\nBuild the image:\r\n\r\n```bash\r\n$ docker build -t reportportal/newman --build-arg VERSION=\"full semver version\".\r\n```\r\n\r\n**Step 3:**\r\n\r\nRun a collection using the newman image:\r\n\r\n```bash\r\n$ docker run -t reportportal/newman run https://www.getpostman.com/collections/8a0c9bc08f062d12dcda \\\r\n -r @reportportal/reportportal \\\r\n --reporter-@reportportal/reportportal-debug=true \\\r\n --reporter-@reportportal/reportportal-endpoint=http://your-instance.com:8080/api/v1 \\\r\n --reporter-@reportportal/reportportal-token=00000000-0000-0000-0000-000000000000 \\\r\n --reporter-@reportportal/reportportal-launch=LAUNCH_NAME \\\r\n --reporter-@reportportal/reportportal-project=PROJECT_NAME \\\r\n -x\r\n```\r\n\r\n# Copyright Notice\r\n\r\nLicensed under the [Apache License v2.0](LICENSE)\r\n\r\n# Contribution and Support\r\n\r\n\r\n\r\n**Implemented and supported by Ahold Delheize**\r\n","readmeFilename":"README.md"}