Skip to end of metadata
Go to start of metadata

Child pages:


Overview

This page is to provide detail on the contribution process for CPS.

Joining the ONAP Community 

Development Procedures and Policies

Code Repos

Code Contribution

Kanban board

https://jira.onap.org/secure/RapidBoard.jspa?projectKey=CPS&rapidView=228

CPS Team Way-of-Working

  1. Jira Stories/Task are groomed by team in weekly meeting or on demand as required
    1. The label 'Groomed' will be added when the team agrees there is enough information in the ticket, the scope is clear and acceptance criteria are defined
    2. Grooming is not compulsory for Jira (sub)tasks (not affecting source code)
  2. Backlog should be in priority order.
    1. Check bugs first, unless specially agreed they always have the highest priority 
    2. Check the next available user story is 'Groomed' and there are no blocking dependencies
      1. if it not groomed but seems to be next in line, call a quick meeting with PTL and available team members to groom it as soon as is practical
    3. Check with PTL if story can be taken as there could always be last minute updates or changes that might prioritize a different task
    4. Inform team about you intention to take user story
    5. Assign user story to yourself
    6. Set user story to In progress! (even if starting with some study first)
    7. If required (typically agreed during grooming) create a Implementation Proposal page here:  Implementation Proposals
      1. You might find a proposal  is needed anyway and help you code and share intention for code solution with team and or address specific issues that are discovered during implementation phase
      2. Implementation Proposals are also good for knowledge sharing with the team and a quick meeting about it might be required depending on the nature of the user story
      3. Implementation Proposals can also serve as permanent developer documentation and might require further addition e.g. for CPS Exceptions and REST APIs HTTP Response Codes
    8. Sub task(s) can be created to track the work (especially for larger user stories) and/or delegate but this is optional
  3. Commit early and frequently
    1. It is always good to give the team a heads up and share early!
    2. Ensure all team developers are added as reviewer, see Team Members
    3. The WiP flag in Gerrit can be used to indicate that review is not ready for review with a fine toothcomb yet
  4. All java code commits should be accompanied with test ware covering the new or modified code (unless agreed by team to handle it in a separate commit in special circumstances) 
  5. Review promptly, none of us like context switching but we cant have developer sitting and waiting for reviews either, try to balance this!
    1. Use Code Review Checklist : CPS Code Review Check List
    2. Please review completely ie. it shouldn't be necessary to add more comments on unchanged code after committer as applied your previous comments.
    3. Please close any resolve commits using 'Done' option. It is up to the commenter to re-open if they don't agree with your solution.
  6. Depending on the user story a demo might be required before it can be closed
    1. Demos should be recorded and added to CPS User Story Demos

Code, Merge requirements and Jira updates are further detailed in next few sections

JIRA Status Updates

Move To

When

In-progress

The moment you start working on it (incl. analysis)

Submitted

The review is merged, merge & CICD jobs are successful.

ClosedDocumentations are updated. Complete demo to team.

Committer Strategy

  • Each review requires 2 committers to +1 and/or +2.
  • A +2 from committer or PTL have the permissions to merge code.
  • See also Committer Best Practices

Code Requirements

  1. Copyright included in each file.  Apache 2 for coding files.
    1. The Copyright line for contributing organization inserted or updated reflecting the contribution year.
  2. A LICENSE.txt file placed at the root of the repo to provide umbrella coverage.
  3. Unit testing coverage > 90% using Persistence Layer Testing and  Groovy & Spock
  4. We will follow ONAP Recommended Software Development Best Practices: Developer Best Practices
  5. Setting Up Your Development Environment details a general set up for ONAP projects. Please note the CPS Specific requirements below!

Antlr plugin set up for cps-path-parser (optional)

The cps-path-parser module uses Antlr. IntelliJ has an Antlr-v4 plugin If you want to use it it needs to be configured as follows:

  1. Right-click on cps-path-parser/src/main/antlr4/org/onap/cps/cpspath/parser/antlr4/CpsPath.g4 file in the project file tree.
  2. Select "Configure ANTLR..."
  3. Set "Output directory where all output is generated" to <your git repo>\cps-path-parser\target\generated-sources\antlr4
  4. Set "Package/namespace for the generated code" to: org.onap.cps.cpspath.parser.antlr4
  5. Click [OK] 

CPS Specific Code Style set up

  • InteliJ IDE: As we have noticed some slight formatting issues that are not controlled by the IDE we prefer that CPS contributors use IntelliJ (community edition is perfectly good for Java development)
  • CPS CheckStyle Scheme: CPS as extended the standard ONAP CheckStyle configuration. Once you have downloaded CPS you can find the definition in <your_git_folder>checkstyle/src/main/resources/cps-java-style.xml
  • Groovy: CPS uses Groovy/Spock for unit testing. There is some additional formatting setup to ensure consistent formatting of Groovy files.

Configure CPS code CheckStyle Plugin for IntelliJ

  1. Select, File, Settings, Tools, Checkstyle  
  2. Click on + beside the 'Configuration File' box to add a configuration
  3. Set description to something like 'ONAP Rules'
  4. Click on Browse to select the file <your_git_folder>checkstyle/src/main/resources/cps-java-style.xml
  5. Complete the Wizard (you can set exclusion properties if needed)
  6. Activate the Configuration File you just added by selecting the relevant checkbox
  7. optional: Click [OK] to close the settings popup

Configure CPS code style auto formatting for IntelliJ (using the same CheckStyle rules and automating it for you (smile))

  1. Select, File, Settings, Editor, Code Style
  2. Click on the gear icon at the end of the line for "Scheme:"
  3. Optional: As importing a schema overrides the current scheme you might want to first use the 'Duplicate..' and  'Rename...' options to create an easily identifiable scheme e.g. 'CPS Standard'
  4. Import Scheme→Checkstyle Configuration
  5. Click on Browse to select the file  <your_git_folder>checkstyle/src/main/resources/cps-java-style.xml
  6. optional: Click [OK] to close the settings popup

Configure CPS Java code style auto formatting for IntelliJ

  1. Select, File, Settings, Editor, Code Style, Java
  2. Ensure the same scheme is selected (as suggested in step 3 in the previous instructions: 'CPS Standard')
  3. Click [OK] to close the settings popup

Configure CPS Groovy code style auto formatting for IntelliJ

  1. Select, File, Settings, Editor, Code Style, Groovy
  2. Ensure the same scheme is selected (as suggested in step 3 in the previous instructions: 'CPS Standard') However does does not affect Groovy setting and you manually need to set below too:
    1. Select 'Tabs and Indents' tab
    2. Set 'Tab size' to 4
    3. Set 'Indent' to 4
    4. Set 'Continuation indent' to 4
    5. Set 'Label indent' to (this is the only one that is different from Java and it to indent under the give: when then: labels!)
    6. Select 'Imports' tab
    7. Set 'Class count to use import with '*'' to 999
    8. Set 'Names count to use static import with '*'' to 999
  3. Click [OK] to close the settings popup

Code Submissions

  • Any CheckStyle issues must be fixed in current review.
  • Code must be covered by tests.
  • We are currently in the process of setting up sonarqube to check our code coverage. Please use the sonarqube plugin for now to measure coverage. To setup sonarqube see dev setup guide: Setting Up Your Development Environment#LocalSonarQubeSetup
  • Mark the review as WIP if it is not ready for review.

Commit Messages

  • Commit message must be in the following format: 

Comment explaining what is the purpose of the code.

Issue-ID: CPS-1

See also: Commit Messages

License Declarations

The following license template needs to be added and kept updated in CPS files (using the commenting scheme corresponding to each type of file):

License Template
/*
 * ============LICENSE_START=======================================================
 * Copyright (C) YYYY[-XXXX] <an organization>
 * Modifications Copyright (C) YYYY[-XXXX] <another organization>
 * ================================================================================
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 * ============LICENSE_END=========================================================
 */

Notes:

  • SPDX-License-Identifier is required by Nordix and agreed by Bell Canada.

References:

CPS Code Review Checklist

Common Style Conventions

*This table just list the most commonly required style conventions  in CPS, it is not to be intended to be complete

Language / DomainType of objectStyleExample
Java / GroovyPackagelowercase
org.onap.cps.rest.controller
ClassUpperCamelCase
AdminRestController
VariablelowerCamelCasecpsAdminService
MethodlowerCamelCasecreateDataspace
JSONPropertylowerCamelCasecmHandles
Open API  / REST
see ONAP Swagger Style
Resource / Nodelowercase(?) pluraldataspaces
Model  / ComponentUpperCamelCase

RestDmiPluginRegistration

PropertylowerCamelCasecmHandles
SQLTableUPPER_SNAKE_CASE (singular)FRAGMENT
FieldUPPER_SNAKE_CASEDATASPACE_ID
LiquibaseTablelower_snake_casefragment
Fieldlower_snake_casedataspace_id

Code Analysis

We recommend that most user stories are accompanied with  small wiki page to document/clarify some analysis for that user story.

See Implementation Proposals

Unit Test

CPS is promoting Groovy and Spock for our unit test. All new modified code should include good quality test

see Groovy & Spock you can also contact the PTL Toine Siebelink for more details


DB Schema  Changes (Liquibase Change Sets)

See

User Story Demos

As part of our best practice to finish a user story it should be demonstrated to team and if possible recorded

see CPS User Story Demos

Jenkins Job 

ONAP uses Jenkins based CICD tool chain.  However, contributors are only given read access to the Jenkins servers.  All jobs are created by automatic generation from JJB definitions. 

https://jenkins.onap.org./view/cps/

Bug reporting

https://jira.onap.org/secure/RapidBoard.jspa?rapidView=228&projectKey=CPS&view=planning&issueLimit=100

Vulnerability report process

If you find any vulnerability please email the security contact with the information that you have.

The security contact is ; toine.siebelink@est.tech

We will give credit to anyone who reports a vulnerability so that we can fix it. If you wish to remain anonymous instead, please let us know and we will respect that.

Documentation



  • No labels