PMD Static Code Analysis with Snapshot

This document explains how to utilize PMD Static Code Analysis with Metazoa Snapshot for analyzing Apex code quality in Salesforce.

Introduction

Metazoa Snapshot is a tool for Salesforce org management and optimization. It integrates with PMD, an open-source static code analysis tool, to facilitate Apex code quality analysis within Salesforce organizations.

Setting up Code Quality Report

1. Connect to Salesforce Orgs: Launch Snapshot Desktop and connect your Salesforce orgs.
2. Access Apex Code Quality Report: Right-click on any connected org and select the Apex Code Quality Report option. This report provides an overview of Apex classes and test classes in the Salesforce organization.
3. Analyze Apex Code: On the left-hand side of the Apex Code Quality Report, you will find a list of all Apex classes and tests. Click on any class or test to view the programming flaws in the selected Apex script in the middle section of the report. This section will highlight issues like security violations, where you may need to validate CRUD permissions before executing a SOQL operation.
4. Select Classes and Tests for Report: You can select specific classes or tests to include in the report by checking the boxes next to them.
5. Manage Report Quality Settings: Click the ‘Manage Quality’ button to control the definition of different problems. For example, you can set ‘Best Practices’ to be excluded from the report, while marking ‘Performance’ as highly recommended, and ‘Apex Documentation’ as optional. The report will be color-coded according to the preferences set.
6. Scheduling Reports: The ‘Display Report’ tab enables you to schedule code quality reports for any Salesforce org. You can choose to send the report as a PDF, CSV, or HTML via email or Salesforce Chatter. The reports can be scheduled to send unconditionally or only when changes are required for the Salesforce org. This allows for monitoring and triggering alerts when issues arise.
7. Code Quality in Deployment: The Code Quality Report can be utilized during the deployment process. In the main deployment tab, you can opt to test code quality as part of deployment. You can also set code quality gateways by selecting whether to halt deployment if a quality problem is reported and specifying the severity of the problem. This empowers administrators to enforce code quality standards for Salesforce orgs.

PMD Integration

Metazoa Snapshot integrates with PMD, an open-source static code analysis tool. PMD is well-regarded for its code quality analysis, particularly for Apex in Salesforce. It offers numerous rules for analyzing Apex code. PMD is compatible with Mac and Windows, and is easy to install on your local machine. By leveraging PMD within Snapshot, users can efficiently monitor their Salesforce organizations and establish code quality gateways to enforce coding standards.

Conclusion

Using PMD static code analysis with Metazoa Snapshot enhances the ability to monitor and maintain code quality within Salesforce organizations. Through scheduling, customizing reports, and integrating code quality checks into the deployment process, organizations can ensure that their Apex code adheres to the desired standards and best practices.