...
| Question | Description | Sample Answer | |
|---|---|---|---|
Basics: Identification | |||
This is a short name. It SHOULD include "ONAP" as part of it. | ONAP CLAMP (Closed Loop Automation Management Platform) | ||
Include a paragraph describing your project. You MUST include "ONAP" as part of it the description in order for our queries to work. | ONAP CLAMP is a platform for designing and managing control loops. It is used to design a closed loop, configure it with specific parameters for a particular ... etc ... | ||
Use the wiki URL for your project. Only use the HTTPS version. | https://wiki.onap.org/display/DW/CLAMP+Project | ||
| What is the URL for the version control repository (it may be the same as the project URL)? | This will be the Gerrit URL for your project. It MUST start with either <https://gerrit.onap.org/r/#/admin/projects> or <https://git.onap.org>. You may list multiple URLs here if your report is covering multiple repositories. Separate them with whitespace. | https://gerrit.onap.org/r/#/admin/projects/clamp | |
What programming language(s) are used to implement the project? | C++, Java, JavaScript, Python, etc. | ||
| The textual answer is optional; you may leave it blank. | |||
| Question | Description | Sample Answer | |
Basics: Basic project website content | |||
| The project website MUST succinctly describe what the software does | ONAP requires this, so you can just select the Met radio button. You can link to your readme file on onap.readthedocs.io | The description of the project can be found in | |
| The project website MUST provide information on how to: obtain, provide feedback (as bug reports or enhancements), and contribute to the software | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The following URLs describe the process to join the community, developing the software and provide feekback: https://wiki.onap.org/display/DW/Joining+the+Community https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA https://wiki.onap.org/display/DW/Developing+ONAP | |
| The information on how to contribute MUST explain the contribution process (e.g., are pull requests used?) (URL required) | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The process could be found in the following URL: https://wiki.onap.org/display/DW/Development+Procedures+and+Policies | |
| The information on how to contribute SHOULD include the requirements for acceptable contributions (e.g., a reference to any required coding standard). | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The Javascript code should meet the requirements except for the number of characters in a line of code specified by the styleguide | |
| Question | Description | Sample Answer | |
Basics: FLOSS license | |||
What license(s) is the project released under? | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | Apache-2.0 | |
| The software produced by the project MUST be released as FLOSS. | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The Apache-2.0 license is approved by the Open Source Initiative (OSI). | |
| It is SUGGESTED that any required license(s) for the software produced by the project be approved by the Open Source Initiative (OSI) | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | The Apache-2.0 license is approved by the Open Source Initiative (OSI). | |
| The project MUST post the license(s) of its results in a standard location in their source repository. (URL require | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | License can be found in: | |
| Question | Description | Sample Answer | |
Basics: Documentation | |||
| The project MUST provide basic documentation for the software produced by the project. | ONAP requires this, so you can just select the Met radio button. Use a pointer to your project's readthedocs.io area. | The documentation describing the project can be found in | |
| The project MUST provide reference documentation that describes the external interface (both input and output) of the software produced by the project. | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The component sparky-fe needs to be used with sparky-be and AAI to view AAI component. | |
| Question | Description | Sample Answer | |
Basics: Other | |||
| The project sites (website, repository, and download URLs) MUST support HTTPS using TLS. | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The project sites are all HTTPS: | |
| The project MUST have one or more mechanisms for discussion (including proposed changes and issues) that are searchable, allow messages and topics to be addressed by URL, enable new people to participate in some of the discussions, and do not require client-side installation of proprietary software. | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | A mailing list is used for project related discussion. New users could also check, search the old discussion online at onap-discuss website. Joining the ONAP Technical Community | |
| The project SHOULD provide documentation in English and be able to accept bug reports and comments about code in English. | ONAP requires this, so you can just select the Met radio button. Use the text in the sample answer. | JIRA is used to track bugs. The whole website is in English. Tracking Issues with JIRA | |
| Question | Description | Sample Answer | |
| Change Control: Public version-controlled source repository | |||
| The project MUST have a version-controlled source repository that is publicly readable and has a URL. | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Sparky's version controlled repository can be found in | |
| The project's source repository MUST track what changes were made, who made the changes, and when the changes were made. | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Tracking is provided by using a combination of JIRA and git history. Every commit has an user and a Jira number attached to it. | |
| To enable collaborative review, the project's source repository MUST include interim versions for review between releases; it MUST NOT include only final releases. | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Gerrit provides an temperate branch for reviewing and providing comments. Once approved, the code will be merged and the temperate branch will be removed. | |
| It is SUGGESTED that common distributed version control software be used (e.g., git) for the project's source repository. | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Git and Gerrit are used. | |
| Question | Description | Sample Answer | |
Change Control: Unique version numbering | |||
| The project results MUST have a unique version identifier for each release intended to be used by users | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Release version is with format ${major}.${minor}.${patch} and will be updated accordingly for each release. | |
| It is SUGGESTED that the Semantic Versioning (SemVer) format be used for releases | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Release version is with format ${major}.${minor}.${patch} and will be updated accordingly for each release. | |
| It is SUGGESTED that projects identify each release within their version control system. For example, it is SUGGESTED that those using git identify each release using git tags. [version_tags] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Each release is tagged within the Gerrit repository. | |
| Question | Description | Sample Answer | |
Change Control: Release notes | |||
| The project MUST provide, in each release, release notes that are a human-readable summary of major changes in that release to help users determine if they should upgrade and what the upgrade impact will be. The release notes MUST NOT be the raw output of a version control log (e.g., the "git log" command results are not release notes). Projects whose results are not intended for reuse in multiple locations (such as the software for a single website or service) AND employ continuous delivery MAY select "N/A". (URL required) [release_notes] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Release notes can be found in | |
| The release notes MUST identify every publicly known vulnerability with a CVE assignment or similar that is fixed in each new release, unless users typically cannot practically update the software themselves. If there are no release notes or there have been no publicly known vulnerabilities, choose "not applicable" (N/A). [release_notes_vulns] | If your project has had a vulnerability reported (e.g. identified in Nexus-IQ), verify that it is noted in the release notes with a CVE, CVSS, CWE, or CAPEC identifier, then select the Met radio button. (If not, select the Unmet radio button.) If there have been no vulnerabilities yet reported, select N/A. | Release notes with identified vulnerabilities can be found in No vulnerabilities have yet been identified. | |
| Question | Description | Sample Answer | |
Reporting: Bug-reporting process | |||
| The project MUST provide a process for users to submit bug reports (e.g., using an issue tracker or a mailing list). (URL required) [report_process] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The description of the process can be found in the following URL: https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA | |
| The project SHOULD use an issue tracker for tracking individual issues. [report_tracker] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Jira is used to track issues. https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA | |
| The project MUST acknowledge a majority of bug reports submitted in the last 2-12 months (inclusive); the response need not include a fix. | ONAP requires that the PTLs review bug reports, so you can just select the Met radio button. Use text similar to the sample answer. | The reported issues are being handled as soon as possible. | |
| The project SHOULD respond to a majority (>50%) of enhancement requests in the last 2-12 months (inclusive).[enhancement_responses] | ONAP requires that the PTLs review enhancement requests, so you can just select the Met radio button. Use text similar to the sample answer. | The reported issues are being handled as soon as possible. | |
| The project MUST have a publicly available archive for reports and responses for later searching. (URL required) [report_archive] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | ||
| Question | Description | Sample Answer | |
Change Control: Vulnerability report process | |||
| The project MUST publish the process for reporting vulnerabilities on the project site. (URL required) [vulnerability_report_process] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | The process on how to report a vulnerability can be found in | |
| If private vulnerability reports are supported, the project MUST include how to send the information in a way that is kept private. (URL required) [vulnerability_report_private] | ONAP does not support private vulnerability reports at this time, so you can just select the N/A radio button. Use text similar to the sample answer. Examples include a private defect report submitted on the web using HTTPS (TLS) or an email encrypted using OpenPGP. If vulnerability reports are always public (so there are never private vulnerability reports), choose "not applicable" (N/A). | Private vulnerability reports are not supported. | |
| The project's initial response time for any vulnerability report received in the last 6 months MUST be less than or equal to 14 days. [vulnerability_report_response] | For most new projects there are no vulnerability reported, so N/A would be a valid selection if that is the case for your project. For older projects that were in a previous ONAP release, the JIRA tickets should be reviewed for vulnerability response times. | There's no vulnerabilities reported so far. | |
| Question | Description | Sample Answer | |
Quality: Working build system | |||
| If the software produced by the project requires building for use, the project MUST provide a working build system that can automatically rebuild the software from source code. [build] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Jenkins is used to build the war file. https://jenkins.onap.org/view/aai/job/aai-sparky-fe-master-release-version-java-daily-no-sonar/ | |
| It is SUGGESTED that common tools be used for building the software. [build_common_tools] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Maven and npm are used to build the project | |
| The project SHOULD be buildable using only FLOSS tools | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Maven is under Apache 2.0 liscense. And NPM is licensed under The Artistic License 2.0 | |
| Question | Description | Sample Answer | |
Quality: Automated test suite | |||
| The project MUST use at least one automated test suite that is publicly released as FLOSS (this test suite may be maintained as a separate FLOSS project). [test] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Sparky uses Karma, mock-require and mocha to run the unit tests | |
| A test suite SHOULD be invocable in a standard way for that language. [test_invocation] | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Tests can be run, by running the command "npm test" | |
| It is SUGGESTED that the test suite cover most (or ideally all) the code branches, input fields, and functionality. | ONAP has differing requirements for each release; depending on your coverage, select the appropriate radio button. Use text similar to the sample answer. | The combination of Karma, mock-require and mocha has the ability to cover all the branches and input fields | |
| It is SUGGESTED that the project implement continuous integration (where new or changed code is frequently integrated into a central code repository and automated tests are run on the result). | ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | For each pull request, the project needs to be built successfully before the Merge option becomes activated. The test will be run automatically during the building process as well. Once build successfully and all tests has past, the Merge option will be activated. | |
| Question | Description | Sample Answer | |
Quality: New functionality testingQuality: Warning flags | The remaining questions in the Quality section must be individually answered according to your project. | ||
| . . . | |||
| Question | Description | Sample Answer | |
Security: Secured delivery against man-in-the-middle (MITM) attacks | |||
| The project MUST use a delivery mechanism that counters MITM attacks. Using https or ssh+scp is acceptable. [delivery_mitm] | ONAP uses HTTPS for access to all ONAP artifacts, such as built items and source. In addition, some artifacts are signed by the Linux Foundation. | HTTPS is used to download all ONAP artifacts, and some are signed by the Linux Foundation. | |
| A cryptographic hash (e.g., a sha1sum) MUST NOT be retrieved over http and used without checking for a cryptographic signature. [delivery_unsigned] | Since all HTTP access is over HTTPS, if ONAP were to to publish checksums, they could only be retrieved using HTTPS. | TBD Does ONAP publish any checksums? If so, the answer is Met. If not, the answer is N/A. | |
Security: Secure development knowledgeSecurity: Use basic good cryptographic practicesSecurity: Publicly known vulnerabilities fixedSecurity: Other security issues | These questions in the Security section must be individually answered according to your project. | ||
| Question | Description | Sample Answer | |
Analysis: Static code analysisAnalysis: Dynamic code analysis | The questions in the Analysis section must be individually answered according to your project. |
...
Sample Silver Level Questions and Answers |
...
| Question | Description | Sample Answer | ||
Basics: IdentificationBasics: Prerequisites | . . . | The questions in these Basics sections will be filled in automatically. | ||
| Question | Description | Sample Answer | ||
Basics: Basic project website content | ||||
| The information on how to contribute MUST include the requirements for acceptable contributions (e.g., a reference to any required coding standard). (URL required) [contribution_requirements] | ONAP has Developer Best Practices, so click on Met and add a reference. | |||
| Question | Description | Sample Answer | ||
Basics: Project oversight | ||||
| The project SHOULD have a legal mechanism where all developers of non-trivial amounts of project software assert that they are legally authorized to make these contributions. The most common and easily-implemented approach for doing this is by using a Developer Certificate of Origin (DCO), where users add "signed-off-by" in their commits and the project links to the DCO website. However, this MAY be implemented as a Contributor License Agreement (CLA), or other legal mechanism. (URL required) [dco] | This question can be answered the same ONAP-wide. | ONAP requires both a Developer Certificate of Origin (DCO), and a Contributor License Agreement (CLA). | ||
| The project MUST clearly define and document its project governance model (the way it makes decisions, including key roles). (URL required) [governance] | This question can be answered the same ONAP-wide. | The project governance is described at https://wiki.onap.org/display/DW/Community+Offices+and+Governance | ||
| The project MUST adopt a code of conduct and post it in a standard location. (URL required) [code_of_conduct] | TBD | |||
| The project MUST clearly define and publicly document the key roles in the project and their responsibilities, including any tasks those roles must perform. It MUST be clear who has which role(s), though this might not be documented in the same way. (URL required) [roles_responsibilities] | This question can be answered the same ONAP-wide. | The key roles in the project and their responsibilities are described at https://wiki.onap.org/display/DW/Community+Offices+and+Governance | ||
| The project MUST be able to continue with minimal interruption if any one person is incapacitated or killed. In particular, the project MUST be able to create and close issues, accept proposed changes, and release versions of software, within a week of confirmation that an individual is incapacitated or killed. This MAY be done by ensuring someone else has any necessary keys, passwords, and legal rights to continue the project. Individuals who run a FLOSS project MAY do this by providing keys in a lockbox and a will providing any needed legal rights (e.g., for DNS names). (URL required) [access_continuity] | ONAP uses the Linux Foundation structure to support all projects, including all keys and passwords. Nothing, including all legal rights, is invested in any single person. | TBD | ||
| The project SHOULD have a "bus factor" of 2 or more. (URL required) [bus_factor] | TBD | |||
| Question | Description | Sample Answer | ||
Basics: Documentation | ||||
| The project MUST have a documented roadmap that describes what the project intends to do and not do for at least the next year. (URL required) [documentation_roadmap] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST include documentation of the architecture (aka high-level design) of the software produced by the project. If the project does not produce software, select "not applicable" (N/A). (URL required) [documentation_architecture] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST document what the user can and cannot expect in terms of security from the software produced by the project (its "security requirements"). (URL required) [documentation_security] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST provide a "quick start" guide for new users to help them quickly do something with the software. (URL required) [documentation_quick_start] | TBD DOES THIS EXIST FOR ONAP? | |||
| The project MUST make an effort to keep the documentation consistent with the current version of the project results (including software produced by the project). Any known documentation defects making it inconsistent MUST be fixed. If the documentation is generally current, but erroneously includes some older information that is no longer true, just treat that as a defect, then track and fix as usual. [documentation_current] | TBD | |||
| The project repository front page and/or website MUST identify and hyperlink to any achievements, including this best practices badge, within 48 hours of public recognition that the achievement has been attained. (URL required) [documentation_achievements] | Add the image for your project's CII badge to your projects's readme.io documentation. Each project is assigned a CII identifier (for example, CLAMP has a CII identifier of 1197). The image URL would be: https://bestpractices.coreinfrastructure.org/projects/1197/badge (using your project's CII identifier instead of 1197).After doing so, click Met. | The badge is visible on the project's readme.io page found at ... | ||
| Question | Description | Sample Answer | ||
Basics: Accessibility and internationalization | ||||
| The project (both project sites and project results) SHOULD follow accessibility best practices so that persons with disabilities can still participate in the project and use the project results where it is reasonable to do so. [accessibility_best_practices] | TBD DO WE HAVE A POLICY ON THIS? | |||
| The software produced by the project SHOULD be internationalized to enable easy localization for the target audience's culture, region, or language. If internationalization (i18n) does not apply (e.g., the software doesn't generate text intended for end-users and doesn't sort human-readable text), select "not applicable" (N/A). [internationalization] | TBD | |||
| Question | Description | Sample Answer | ||
Basics: Other | ||||
| If the project sites (website, repository, and download URLs) store passwords for authentication of external users, the passwords MUST be stored as iterated hashes with a per-user salt by using a key stretching (iterated) algorithm (e.g., PBKDF2, Bcrypt or Scrypt). If the project sites do not store passwords for this purpose, select "not applicable" (N/A). [sites_password_security] | TBD | |||
| Question | Description | Sample Answer | ||
Change Control: Previous versions | ||||
| The project MUST maintain the most often used older versions of the product or provide an upgrade path to newer versions. If the upgrade path is difficult, the project MUST document how to perform the upgrade (e.g., the interfaces that have changed and detailed suggested steps to help upgrade). [maintenance_or_update] | TBD | |||
| Question | Description | Sample Answer | ||
Reporting: Bug-reporting process | ||||
| The project MUST use an issue tracker for tracking individual issues. [report_tracker] | This is a question that changed from a SHOULD in the previous level to a MUST at this level. ONAP uses JIRA, so click Met. (It should be filled in already from the previous level.) | Jira is used to track issues. https://wiki.onap.org/display/DW/Tracking+Issues+with+JIRA | ||
| Question | Description | Sample Answer | ||
Change Control: Vulnerability report process | ||||
| The project MUST give credit to the reporter(s) of all vulnerability reports resolved in the last 12 months, except for the reporter(s) who request anonymity. If there have been no vulnerabilities resolved in the last 12 months, select "not applicable" (N/A). (URL required) [vulnerability_report_credit] | TBD | |||
| The project MUST have a documented process for responding to vulnerability reports. (URL required) [vulnerability_response_process] | TBD WHERE IS THIS DOCUMENTED? | |||
| Question | Description | Sample Answer | ||
Quality: Coding standards | ||||
| The project MUST identify the specific coding style guides for the primary languages it uses, and require that contributions generally comply with it. (URL required) [coding_standards] | TBD WHERE IS THIS DOCUMENTED? | |||
| The project MUST automatically enforce its selected coding style(s) if there is at least one FLOSS tool that can do so in the selected language(s). [coding_standards_enforced] | TBD | |||
| Question | Description | Sample Answer | ||
Quality: Working build systemQuality: Installation systemQuality: Externally-maintained componentsQuality: Automated test suiteQuality: New functionality testingQuality: Warning flags | The questions in the Security section must be individually answered according to your project. | |||
| Question | Description | Sample Answer | ||
Security: Secure development knowledgeSecurity: Use basic good cryptographic practicesSecurity: Secure releaseSecurity: Other security issues | The questions in the Security section must be individually answered according to your project. | |||
| Question | Description | Sample Answer | ||
Analysis: Static code analysisAnalysis: Dynamic code analysis | The questions in the Analysis section must be individually answered according to your project. | Sample Answer |
...