├── .gitignore ├── CODEOWNERS ├── CLI-screenshot.png ├── babel.config.json ├── tests ├── api_contracts │ ├── crocodile_service │ │ ├── endpoints │ │ │ ├── croc_list.js │ │ │ └── crocodile.js │ │ └── README.md │ ├── registration_service │ │ └── endpoints │ │ │ ├── user.js │ │ │ └── register.js │ ├── authentication_service │ │ └── endpoints │ │ │ └── auth_token.js │ └── contracts.js ├── simple.js └── test.js ├── catalog-info.yaml ├── package.json ├── webpack.config.js ├── src └── index.js ├── README.md ├── CODE_OF_CONDUCT.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules -------------------------------------------------------------------------------- /CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @grafana/k6-frontend 2 | -------------------------------------------------------------------------------- /CLI-screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/grafana/k6-jslib-k6chaijs-contracts/HEAD/CLI-screenshot.png -------------------------------------------------------------------------------- /babel.config.json: -------------------------------------------------------------------------------- 1 | { 2 | "presets": [ 3 | [ 4 | "@babel/preset-env" 5 | ] 6 | ], 7 | "plugins": [ "@babel/plugin-transform-block-scoping"] 8 | } 9 | -------------------------------------------------------------------------------- /tests/api_contracts/crocodile_service/endpoints/croc_list.js: -------------------------------------------------------------------------------- 1 | // json schema for https://test-api.k6.io/public/crocodiles/ 2 | 3 | import { crocodileAPIContract } from './crocodile.js' 4 | 5 | export const crocodileListAPIcontract = { 6 | "items": crocodileAPIContract // reusing object from another contract 7 | }; 8 | 9 | -------------------------------------------------------------------------------- /tests/api_contracts/crocodile_service/README.md: -------------------------------------------------------------------------------- 1 | # API contracts for the Crocodile service 2 | 3 | This directory contains all API contracts for the `Crocodile` service. 4 | 5 | The crocodile service is maintained by `Team A`. Contracts have been last updated on `2021-03-21`. 6 | 7 | The contract validation for the service is executed nightly for regression testing purposes. -------------------------------------------------------------------------------- /catalog-info.yaml: -------------------------------------------------------------------------------- 1 | apiVersion: backstage.io/v1alpha1 2 | kind: Component 3 | metadata: 4 | name: k6-jslib-k6chaijs-contracts 5 | title: k6-jslib-k6chaijs-contracts 6 | description: | 7 | API contract validation plugin for k6chaijs library 8 | annotations: 9 | github.com/project-slug: grafana/k6-jslib-k6chaijs-contracts 10 | spec: 11 | type: library 12 | owner: group:default/k6-frontend 13 | lifecycle: production 14 | -------------------------------------------------------------------------------- /tests/api_contracts/registration_service/endpoints/user.js: -------------------------------------------------------------------------------- 1 | // json schema for .. 2 | 3 | export const userAPIContract = { 4 | type: "object", 5 | properties: { 6 | username: { 7 | type: "string" 8 | }, 9 | first_name: { 10 | type: "string" 11 | }, 12 | last_name: { 13 | type: "string" 14 | }, 15 | email: { 16 | type: "string" 17 | }, 18 | password: { 19 | type: "string" 20 | }, 21 | }, 22 | required: [ 23 | "username", 24 | "first_name", 25 | "last_name", 26 | "email", 27 | "password", 28 | ] 29 | }; 30 | -------------------------------------------------------------------------------- /tests/api_contracts/crocodile_service/endpoints/crocodile.js: -------------------------------------------------------------------------------- 1 | // json schema for https://test-api.k6.io/public/crocodiles/1/ 2 | 3 | export const crocodileAPIContract = { 4 | "type": "object", 5 | "properties": { 6 | "id": { 7 | "type": "number" 8 | }, 9 | "name": { 10 | "type": "string" 11 | }, 12 | "age": { 13 | "type": "number", 14 | "minimum": 1, 15 | "maximum": 1000 16 | }, 17 | "date_of_birth": { 18 | "type": "string", 19 | "format": "date" 20 | } 21 | }, 22 | "required": [ 23 | "id", 24 | "name", 25 | "age", 26 | "date_of_birth" 27 | ] 28 | }; 29 | -------------------------------------------------------------------------------- /tests/api_contracts/authentication_service/endpoints/auth_token.js: -------------------------------------------------------------------------------- 1 | // json schema for https://test-api.k6.io/auth/token/login/ 2 | 3 | export const tokenAuthRequestAPIcontract = { 4 | type: "object", 5 | properties: { 6 | username: { 7 | type: "string" 8 | }, 9 | password: { 10 | type: "string" 11 | }, 12 | }, 13 | required: [ 14 | "username", 15 | "password", 16 | ] 17 | }; 18 | 19 | export const tokenAuthResponseAPIcontract = { 20 | type: "object", 21 | properties: { 22 | access: { 23 | type: "string" 24 | }, 25 | refresh: { 26 | type: "string" 27 | }, 28 | }, 29 | required: [ 30 | "access", 31 | "refresh", 32 | ] 33 | }; 34 | -------------------------------------------------------------------------------- /tests/api_contracts/contracts.js: -------------------------------------------------------------------------------- 1 | // This file collects all contracts in one place 2 | // This makes it easy to import in the k6 script 3 | 4 | import { crocodileAPIContract } from './crocodile_service/endpoints/crocodile.js' 5 | import { crocodileListAPIcontract } from './crocodile_service/endpoints/croc_list.js' 6 | import { registerAPIcontract, registerAPIResponseContract } from './registration_service/endpoints/register.js' 7 | import { tokenAuthRequestAPIcontract, tokenAuthResponseAPIcontract } from './authentication_service/endpoints/auth_token.js' 8 | 9 | 10 | export { 11 | crocodileAPIContract, 12 | crocodileListAPIcontract, 13 | registerAPIcontract, 14 | registerAPIResponseContract, 15 | tokenAuthRequestAPIcontract, 16 | tokenAuthResponseAPIcontract, 17 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "k6-es6", 3 | "version": "1.0.0", 4 | "description": "Create a k6chaijs-contract build", 5 | "main": "src/index.js", 6 | "devDependencies": { 7 | "@babel/core": "^7.4.4", 8 | "@babel/plugin-transform-block-scoping": "^7.14.1", 9 | "@babel/preset-env": "^7.4.4", 10 | "uglifyjs-webpack-plugin": "^2.2.0", 11 | "babel-loader": "^8.0.6", 12 | "chai": "4.3.4", 13 | "webpack": "^4.47.0", 14 | "webpack-cli": "^3.3.2" 15 | }, 16 | "engines": {}, 17 | "scripts": { 18 | "webpack": "webpack", 19 | "test": "echo \"Error: no test specified\" && exit 1" 20 | }, 21 | "keywords": [ 22 | "k6" 23 | ], 24 | "author": "k6 team", 25 | "license": "MIT", 26 | "dependencies": { 27 | "ajv": "6.12.5" 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | var webpack = require('webpack'); 2 | var path = require('path'); 3 | 4 | const UglifyJsPlugin = require('uglifyjs-webpack-plugin'); 5 | 6 | module.exports = { 7 | mode: 'production', 8 | entry: './src/index.js', 9 | output: { 10 | filename: 'k6chaijs-contracts.min.js', 11 | path: path.resolve(__dirname, 'build'), 12 | libraryTarget: 'commonjs', 13 | }, 14 | module: { 15 | rules: [ 16 | { 17 | test: /\.js$/, 18 | loader: 'babel-loader', 19 | }, 20 | ], 21 | }, 22 | stats: { 23 | colors: true, 24 | }, 25 | target: 'web', 26 | externals: /^(k6|https?\:\/\/)(\/.*)?/, 27 | devtool: 'source-map', 28 | optimization: { 29 | minimizer: [ 30 | new UglifyJsPlugin({ 31 | uglifyOptions: { 32 | output: { 33 | comments: false 34 | } 35 | } 36 | }) 37 | ] 38 | } 39 | }; 40 | -------------------------------------------------------------------------------- /tests/simple.js: -------------------------------------------------------------------------------- 1 | import http from 'k6/http'; 2 | import { describe, expect, chai } from 'https://jslib.k6.io/k6chaijs/4.3.4.0/index.js'; 3 | import { initContractPlugin } from '../build/k6chaijs-contracts.min.js'; 4 | 5 | import { crocodileListAPIcontract } from './api_contracts/contracts.js' 6 | 7 | export let options = { 8 | thresholds: { 9 | checks: [{ threshold: 'rate == 1.00', abortOnFail: true }], 10 | http_req_failed: [{ threshold: 'rate == 0.00', abortOnFail: true }], 11 | }, 12 | }; 13 | 14 | 15 | initContractPlugin(chai) 16 | 17 | 18 | export default function testSuite() { 19 | 20 | describe('[Crocs service] Fetch list of crocs', () => { 21 | let response = http.get('https://test-api.k6.io/public/crocodiles'); 22 | 23 | expect(response.status, "response status").to.equal(200) 24 | expect(response).to.have.validJsonBody() 25 | expect(response.json(), "Croc List schema").to.matchSchema(crocodileListAPIcontract) 26 | }) 27 | 28 | } 29 | -------------------------------------------------------------------------------- /src/index.js: -------------------------------------------------------------------------------- 1 | import { check } from 'k6'; 2 | import Ajv from 'ajv'; 3 | 4 | export function initContractPlugin(chai){ 5 | var _ajv = new Ajv(); 6 | 7 | chai.util.addMethod(chai.Assertion.prototype, 'matchSchema', function (schema) { 8 | var data = chai.util.flag(this, 'object'); 9 | 10 | let validate = _ajv.compile(schema); 11 | 12 | let is_valid = validate(data, schema); 13 | 14 | // optional. It records specific error messages as checks. 15 | if (!is_valid) { 16 | console.error(JSON.stringify(validate.errors)); 17 | 18 | validate.errors.forEach(error => { 19 | check(is_valid, { 20 | [`${error.dataPath} ${error.message}`]: (is_valid) => is_valid 21 | }); 22 | }); 23 | } 24 | 25 | this.assert( 26 | is_valid 27 | , "expected to match API schema" 28 | , "expected to not not match the API schema" 29 | , null // expected 30 | , null // actual 31 | ); 32 | }); 33 | 34 | 35 | } 36 | -------------------------------------------------------------------------------- /tests/api_contracts/registration_service/endpoints/register.js: -------------------------------------------------------------------------------- 1 | // json schema for https://test-api.k6.io/public/crocodiles/1/ 2 | 3 | export const registerAPIcontract = { 4 | type: "object", 5 | properties: { 6 | username: { 7 | type: "string" 8 | }, 9 | first_name: { 10 | type: "string" 11 | }, 12 | last_name: { 13 | type: "string" 14 | }, 15 | email: { 16 | type: "string" 17 | }, 18 | password: { 19 | type: "string" 20 | }, 21 | }, 22 | required: [ 23 | "username", 24 | "first_name", 25 | "last_name", 26 | "email", 27 | "password", 28 | ] 29 | }; 30 | 31 | // this is the structure the /user/register endpoint responds with on success 32 | export const registerAPIResponseContract = { 33 | type: "object", 34 | properties: { 35 | username: { 36 | type: "string" 37 | }, 38 | first_name: { 39 | type: "string" 40 | }, 41 | last_name: { 42 | type: "string" 43 | }, 44 | email: { 45 | type: "string" 46 | }, 47 | }, 48 | required: [ 49 | "username", 50 | "first_name", 51 | "last_name", 52 | "email", 53 | ] 54 | }; 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # API contract validation plugin for k6Chaijs Assertion Library 2 | 3 | Installation docs: http://k6.io/docs/javascript-api/jslib/chaijs 4 | 5 | API docs: https://www.chaijs.com/api/bdd/ 6 | 7 | Download from: https://jslib.k6.io/ 8 | 9 | ```js 10 | import http from 'k6/http'; 11 | import { describe, expect, chai } from 'https://jslib.k6.io/k6chaijs/4.3.4.0/index.js'; 12 | import { initContractPlugin } from 'https://jslib.k6.io/k6chaijs-contracts/4.3.4.0/index.js'; 13 | 14 | import { crocodileListAPIcontract } from './api_contracts/contracts.js' 15 | 16 | export let options = { 17 | thresholds: { 18 | checks: [{ threshold: 'rate == 1.00', abortOnFail: true }], 19 | http_req_failed: [{ threshold: 'rate == 0.00', abortOnFail: true }], 20 | }, 21 | }; 22 | 23 | initContractPlugin(chai) 24 | 25 | export default function testSuite() { 26 | 27 | describe('[Crocs service] Fetch list of crocs', () => { 28 | let response = http.get('https://test-api.k6.io/public/crocodiles'); 29 | 30 | expect(response.status, "response status").to.equal(200) 31 | expect(response).to.have.validJsonBody() 32 | expect(response.json(), "Croc List schema").to.matchSchema(crocodileListAPIcontract) 33 | }) 34 | 35 | } 36 | ``` 37 | 38 | ![CLI screenshot](./CLI-screenshot.png) 39 | 40 | ## Development 41 | 42 | #### Build 43 | ``` 44 | npm install 45 | npm run-script webpack 46 | ``` 47 | 48 | #### Deploy new version 49 | 1. Build. 50 | 2. Use the `./build/k6chaijs-contracts.min.js` to make a PR to [jslib.k6.io](https://github.com/grafana/jslib.k6.io). 51 | 3. Release version should follow the chaijs version. Currently `4.3.4.0`. 52 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, gender identity and expression, level of experience, 9 | nationality, personal appearance, race, religion, or sexual identity and 10 | orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting our Developer Relations team, avocados@k6.io. 59 | 60 | All complaints will be reviewed and investigated and will result in a response that 61 | is deemed necessary and appropriate to the circumstances. The project team is 62 | obligated to maintain confidentiality with regard to the reporter of an incident. 63 | Further details of specific enforcement policies may be posted separately. 64 | 65 | Project maintainers who do not follow or enforce the Code of Conduct in good 66 | faith may face temporary or permanent repercussions as determined by other 67 | members of the project's leadership. 68 | 69 | ## Attribution 70 | 71 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 72 | available at [http://contributor-covenant.org/version/1/4][version] 73 | 74 | [homepage]: http://contributor-covenant.org 75 | [version]: http://contributor-covenant.org/version/1/4/ 76 | -------------------------------------------------------------------------------- /tests/test.js: -------------------------------------------------------------------------------- 1 | import { describe, expect, chai } from 'https://jslib.k6.io/k6chaijs/4.3.4.0/index.js'; 2 | import { initContractPlugin } from '../build/k6chaijs-contracts.min.js'; 3 | 4 | import { Httpx, Get } from 'https://jslib.k6.io/httpx/0.0.4/index.js'; 5 | import { randomString } from 'https://jslib.k6.io/k6-utils/1.0.0/index.js'; 6 | 7 | import { 8 | registerAPIcontract, 9 | crocodileAPIContract, 10 | crocodileListAPIcontract, 11 | registerAPIResponseContract, 12 | tokenAuthResponseAPIcontract, 13 | tokenAuthRequestAPIcontract} from './api_contracts/contracts.js' 14 | 15 | 16 | initContractPlugin(chai) 17 | 18 | 19 | export let options = { 20 | thresholds: { 21 | // fail the test if any checks fail or any requests fail 22 | checks: [{ threshold: 'rate == 1.00', abortOnFail: true }], 23 | http_req_failed: [{ threshold: 'rate == 0.00', abortOnFail: true }], 24 | }, 25 | }; 26 | 27 | let session = new Httpx(); 28 | session.setBaseUrl('https://test-api.k6.io'); 29 | 30 | function validateContractsPublicCrocodileService(){ 31 | 32 | describe('[Crocs service] Fetch public crocs', () => { 33 | let responses = session.batch([ 34 | new Get('/public/crocodiles/1/'), 35 | new Get('/public/crocodiles/2/'), 36 | ]); 37 | 38 | responses.forEach(response => { 39 | expect(response.status, "response status").to.equal(200); 40 | expect(response, "My response 1").to.have.validJsonBody() 41 | expect(response.json(), "Croc API schema").to.matchSchema(crocodileAPIContract) 42 | }); 43 | }); 44 | 45 | describe('[Crocs service] Fetch list of crocs', () => { 46 | let response = session.get('/public/crocodiles'); 47 | 48 | expect(response.status, "response status").to.equal(200) 49 | expect(response).to.have.validJsonBody() 50 | expect(response.json(), "Croc List schema").to.matchSchema(crocodileListAPIcontract) 51 | }) 52 | } 53 | 54 | function validateAuthService(){ 55 | 56 | const USERNAME = `${randomString(10)}@example.com`; 57 | const PASSWORD = 'superCroc2021'; 58 | 59 | describe("[Registration service] user registration", () => { 60 | let sampleUser = { 61 | 'username': USERNAME, 62 | 'password': PASSWORD, 63 | 'email': USERNAME, 64 | 'first_name': 'John', 65 | 'last_name': 'Smith' 66 | }; 67 | 68 | expect(sampleUser, "user registration").to.matchSchema(registerAPIcontract); 69 | 70 | let response = session.post(`/user/register/`, sampleUser); 71 | 72 | expect(response.status, "status").to.equal(201); 73 | expect(response).to.have.validJsonBody() 74 | expect(response.json(), "registration response").to.matchSchema(registerAPIResponseContract); 75 | }); 76 | 77 | describe("[Auth service] user authentication", () => { 78 | let authData = { 79 | username: USERNAME, 80 | password: PASSWORD 81 | }; 82 | 83 | expect(authData, "Auth data payload").to.matchSchema(tokenAuthRequestAPIcontract); 84 | 85 | let resp = session.post(`/auth/token/login/`, authData); 86 | 87 | expect(resp.status, "Auth status").to.be.within(200, 204) 88 | expect(resp).to.have.validJsonBody() 89 | expect(resp.json(), "Auth response").to.matchSchema(tokenAuthResponseAPIcontract) // did they reply with the right format? 90 | expect(resp.json('access'), "auth token").anonymize().to.be.a('string'); 91 | 92 | let authToken = resp.json('access'); 93 | // set the authorization header on the session for the subsequent requests. 94 | session.addHeader('Authorization', `Bearer ${authToken}`); 95 | 96 | 97 | }); 98 | } 99 | 100 | function validateContractCreateCrocodileService(){ 101 | // authentication happened before this call. 102 | 103 | describe('[Croc service] Create a new crocodile', () => { 104 | let payload = { 105 | name: `Croc Name`, 106 | sex: "M", 107 | date_of_birth: '2019-01-01', 108 | }; 109 | 110 | let resp = session.post(`/my/crocodiles/`, payload); 111 | 112 | expect(resp.status, "Croc creation status").to.equal(201) 113 | expect(resp).to.have.validJsonBody() 114 | expect(resp.json()).to.matchSchema(crocodileAPIContract); 115 | 116 | session.newCrocId = resp.json('id'); // caching croc ID for the future. 117 | }); 118 | 119 | describe('[Croc service] Fetch private crocs', () => { 120 | let response = session.get('/my/crocodiles/'); 121 | 122 | expect(response.status, "response status").to.equal(200) 123 | expect(response).to.have.validJsonBody() 124 | expect(response).to.matchSchema(crocodileListAPIcontract) 125 | expect(response.json().length, "number of crocs").to.equal(1); 126 | }) 127 | } 128 | 129 | export default function testSuite() { 130 | validateContractsPublicCrocodileService(); 131 | validateAuthService(); 132 | validateContractCreateCrocodileService(); 133 | } 134 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------