...
| 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 [description_good] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Include the 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 [interact] | *ONAP project common response* 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) [contribute] | *ONAP project common response* 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). [contribution_requirements] | *ONAP project common response* 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? [license] | *ONAP project common response* 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. [floss_license] | *ONAP project common response* 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) [floss_license_osi] | *ONAP project common response* 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 required) [license_location] | *ONAP project common response* 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. [documentation_basics] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Include 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. [documentation_interface] | *ONAP project common response* 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. [sites_https] | *ONAP project common response* 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. [discussion] | *ONAP project common response* 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. [english] | *ONAP project common response* 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. [repo_public] | *ONAP project common response* 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. [repo_track] | *ONAP project common response* 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. [repo_interim] | *ONAP project common response* ONAP requires this, so you can just select the Met radio button. Use text similar to the sample answer. | Gerrit provides an temporary 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. [repo_distributed] | *ONAP project common response* 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 [version_unique] | *ONAP project common response* 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 [version_semver] | *ONAP project common response* 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 project common response* 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 project common response* 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 project common response* 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 project common response* 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. [report_responses] | *ONAP project common response* 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 project common response* 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 project common response* 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 project common response* 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 project common response* 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. NOTE: a new process has recently been identified, so this common answer will be changing shortly. | |
| 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 project common response* 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 project common response* 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 [build_floss_tools] | *ONAP project common response* 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 project common response* 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 project common response* 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. [test_most] | 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). [test_continuous_integration] | *ONAP project common response* 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 project common response* 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] | *ONAP project common response* 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. |
...
| Question | Description | Sample Answer | |
Basics: IdentificationBasics: PrerequisitesBasics: Project oversightBasics: Other | The questions in these Basics sections will be filled in automatically. Some questions change SHOULDs from previous levels to MUSTs. | ||
| The project MUST include a copyright statement in each source file, identifying at least one relevant year and copyright holder. [copyright_per_file] | *ONAP project common response* | all source and documentation files are required to have copyright notices | |
| The project MUST include a license statement in each source file. This MAY be done by including the following inside a comment near the beginning of each file: SPDX-License-Identifier: [SPDX license expression for project]. [license_per_file] | *ONAP project common response* | all source and documentation files are required to have license statements | |
| Question | Description | Sample Answer | |
Change Control: Public version-controlled source repository | |||
| The project's source repository MUST use a common distributed version control software (e.g., git or mercurial). [repo_distributed] | This question will be filled in automatically from previous levels. | ||
| The project MUST clearly identify small tasks that can be performed by new or casual contributors. (URL required) [small_tasks] | TBD DO WE HAVE POLICIES ON THIS? | ||
| The project MUST require two-factor authentication (2FA) for developers for changing a central repository or accessing sensitive data (such as private vulnerability reports). This 2FA mechanism MAY use mechanisms without cryptographic mechanisms such as SMS, though that is not recommended. [require_2FA] | TBD DO WE HAVE POLICIES ON THIS? | ||
| The project's two-factor authentication (2FA) SHOULD use cryptographic mechanisms to prevent impersonation. Short Message Service (SMS) based 2FA, by itself, does NOT meet this criterion, since it is not encrypted. [secure_2FA] | TBD DO WE HAVE POLICIES ON THIS? | ||
| Question | Description | Sample Answer | |
Quality: Coding standards | |||
| The project MUST document its code review requirements, including how code review is conducted, what must be checked, and what is required to be acceptable. (URL required) [code_review_standards] | TBD DO WE HAVE POLICIES ON THIS? | ||
| The project MUST have at least 50% of all proposed modifications reviewed before release by a person other than the author, to determine if it is a worthwhile modification and free of known issues which would argue against its inclusion [two_person_review] | *ONAP project common response* ONAP requires a committer other than the submitter to review each proposed modification. | Per https://wiki.onap.org/display/DW/Code+Review, self-commits are not allowed. | |
| Question | Description | Sample Answer | |
Quality: Working build system | |||
| The project MUST have a reproducible build. If no building occurs (e.g., scripting languages where the source code is used directly instead of being compiled), select "not applicable" (N/A). (URL required) [build_reproducible] | TBD AFAIK, WE DO NOT CURRENTLY HAVE A POLICY ON THIS | ||
| Question | Description | Sample Answer | |
Quality: Automated test suite | These questions will be filled in automatically from previous levels. | ||
| The project MUST implement continuous integration, where new or changed code is frequently integrated into a central code repository and automated tests are run on the result. (URL required) [test_continuous_integration] | *ONAP project common response* ONAP uses continuous integration and unit tests run automatically during CI. | Junit tests are invoked from mvn. Pytest tests are invoked by running pytest from command line. Rebar3 tests are invoked from command line by running rebarr3. All are included as part of Jenkin builds. All are standard testing tools invoked in standard way. Robot Framework tests are invoked by standard Robot methodology, also triggered by Jenkins build jobs. https://wiki.onap.org/display/DW/Continuous+Integration https://wiki.onap.org/pages/viewpage.action?pageId=4718718 | |
| A test suite MUST be invocable in a standard way for that language. (URL required) [test_invocation] | TBD WHERE IS THIS DOCUMENTED? A URL IS REQUIRED. | ||
| Question | Description | Sample Answer | |
Security: Use basic good cryptographic practicesSecurity: Secured delivery against man-in-the-middle (MITM) attacksSecurity: Publicly known vulnerabilities fixed | These questions will be filled in automatically from previous levels. | ||
| The project website, repository (if accessible via the web), and download site (if separate) MUST include key hardening headers with nonpermissive values. (URL required) [hardened_site] | This will need to be resolved on an ONAP project basis. We cannot currently answer MET on this item. | Cannot be met yet. | |
| Question | Description | Sample Answer | |
Analysis: Dynamic code analysis | Some questions in the Analysis section will be automatically filled in from previous levels. The remaining questions in the Analysis section must be individually answered according to your project. |
...