Page History

2.1  Grammar and style

These are small things that are not caught by the automated style checkers.

• Does a variable need a better name?
• Should this be a keyword argument?
• In a PR, maintain the existing style of the file.
• Don’t combine code changes with lots of edits of whitespace or comments; it makes code review too difficult. It’s okay to fix an occasional comment or indenting, but if wholesale comment or whitespace changes are needed, make them a separate PR.
• Use the checkstyle plugin in Maven to verify that your PR conforms to our style

2.2  Code Style

• Follow the Google Java Style Guide outlined here: https://google.github.io/styleguide/javaguide.html

2.2.1 IntelliJ IDEA Checkstyle Warnings

Checkstyle: WhitespaceAround: 'if' is not followed by whitespace. Empty blocks may only be represented as {} when not part of a multi-block statement

2.3  Coding Standards

• Implementation matches what the documentation says  

• Logger name is effectively the result of Class.getName() 

• Class & member access - as restricted as it can be (subject to testing requirements)  

• Appropriate NullPointerException and IllegalArgumentException argument checks  

• Asserts - verify they should always be true  
• Look for accidental propagation of exceptions  
• Look for unanticipated runtime exceptions  
• Try-finally used as necessary to restore consistent state  

• Logging levels conform to Log4j levels 

• Possible deadlocks - look for inconsistent locking order  
• Race conditions - look for missing or inadequate synchronization  
• Consistent synchronization - always locking the same object(s)  
• Look for synchronization or documentation saying there's no synchronization  
• Look for possible performance problems  
• Look at boundary conditions for problems  
• Configuration entries are retrieved/set via setter/getter methods  
• Implementation details do NOT leak into interfaces  
• Variables and arguments should be interfaces where possible  

• If equals is overridden then hashCode is overridden (and vice versa)  

• Objects are checked (instanceof) for appropriate type before casting (use generics if possible)  

• Public API changes have been publicly discussed  
• Use of static member variables should be used with caution especially in Map/reduce tasks due to the JVM reuse feature 

2.4 Documentation

• Code-Level

• Documentation
  • Self-documenting code (variable, method, class) has a
clear semantic name
• • clear semantic name
  • Accurate, sufficient for developers to code against
  • Follows standard Javadoc conventions
  • Loggers and logging levels covered if they do not follow our conventions (see below)
  • System properties, configuration options, and resources covered
  • Illegal arguments are properly documented as appropriate
  • Package and overview Javadoc are updated as appropriate
  • Javadoc comments are mandatory for all public APIs
  • Generate Javadocs for release builds
• Feature-level documentation -  should be version controlled in github in README files.
  
  • Accurate description of the feature
  • Sample configuration and deployment options
  • Sample usage scenarios 
• High-Level Design documentation - architecture description and diagrams should be a part of a wiki entry.
  
  • Provide diagrams/charts where appropriate.  Visuals are always welcome
  • Provide purpose of the feature/module and why it exists within the project
  • Describe system flows through the feature/module where appropriate
  • Describe how the feature/module interfaces with the rest of the system
  • Describe appropriate usages scenarios and use cases
• Tutorials - system-level tutorials and use cases should also be kept as wiki entries.
  
  • Add to the Metron reference application documentation for each additional major feature
  • If appropriate, publish a tutorials blog on the Wiki to highlight usage scenarios and apply them to the real world use cases
• Diagrams
  • We save architecture diagram source files in an xml format rendered by draw.io (instructions below). This is the free tool of choice that we've agreed to use for exchanging diagrams and their source files in Metron.
  • Image and diagram source files belong in "<module-name>/images-source" and rendered diagrams and images belong in "<module-name>/images."

2.4.1 Creating and Modifying Diagrams Using draw.io

All steps expect the source and derived image files will be committed to source control via Git.

Creating and Exporting Diagrams as Images

1. Open your diagram in draw.io
2. Select "File → Export as → PNG..." (you can use other formats as well, e.g. SVG)
3. Image Added
4. If using PNG, you can leave the defaults and click "Export." If you want the background transparent, select that option before exporting.
5. Image Added
6. Name your file accordingly and choose "Download."
7. Image Added
8. Place the downloaded file in "<module-name>/images" as noted in the "Diagrams" section under 2.4.0 above. 

Exporting Source Files for Diagrams

1. Open your diagram in draw.io
2. Select "File → Export as → XML..."
3. Image Added
4. Enable the checkbox for "Compressed" and click "Export"
5. Image Added
6. Name your file accordingly and choose "Download."
7. Image Added
8. Open the file you downloaded. Remove the xml header (<?xml version="1.0" encoding="UTF-8"?>), and add the following license header at the top of the file.

9. <!--
     Licensed to the Apache Software
          Foundation (ASF) under one or more contributor license agreements. See the
          NOTICE file distributed with this work for additional information regarding
          copyright ownership. The ASF licenses this file to You 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.
     -->
   <!-- This is a draw.io diagram source file.  You can edit it on http://www.draw.io -->

10. Save the changes and place them in the relevant Maven project module under "<module-name>/images-source" as noted in the "Diagrams" section under 2.4.0 above.

Modifying Existing Diagrams

1. Navigate to draw.io
2. Select "Open Existing Diagram" from the prompt.
3. Image Added
4. Click "Upload" and click "Select a file from your device" and choose the diagram you want to edit.
5. Image Added
6. The file should be open for editing now.
7. Make any desired changes and export the source XML files and new images as described above.

2.5  Tests

• Unit tests exist for bug fixes and new features, or a rationale is given in JIRA for why there is no test 
•  Unit tests do not write any temporary files to /tmp (instead, the tests should write to the location specified by the test.build.data system property)