[MKTAUT-128] Fail checkstyle for Salesforce integration Created: 13/Apr/21  Updated: 28/Apr/21  Resolved: 27/Apr/21

Status: Closed
Project: Marketing Automation
Component/s: None
Affects Version/s: 1.0.2
Fix Version/s: None

Type: Bug Priority: Neutral
Reporter: Viet Nguyen Assignee: Oanh Thai Hoang
Resolution: Not an issue Votes: 0
Labels: maintenance
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: PNG File Screen Shot 2021-04-15 at 13.49.21.png     PNG File Screen Shot 2021-04-15 at 13.52.48.png    
Issue Links:
Cloners
is cloned by MKTAUT-129 Fail unit test for Salesforce integra... Closed
Relates
relates to MKTAUT-129 Fail unit test for Salesforce integra... Closed
causality
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Bug DoR:
[ ]* Steps to reproduce, expected, and actual results filled
[ ]* Affected version filled
Date of First Response:
Epic Link: Ext DAMs maintenance & partnership support
Sprint: Content Mngmt 02
Story Points: 0.5

 Description   

Steps to reproduce

  1.  Build the project at https://git.magnolia-cms.com/projects/ADDON/repos/marketing-automation/browse

.. Logs, screenshots, gifs...

Expected results

  • Build successful

.. Justify non-trivial expectations with a link to a doc or a relevant discussion.

Actual results

  • Fail checkstyle which prevent the module being built

Workaround

  • Skip checkstyle when doing Maven build `mvn [target] -Dcheckstyle.skip`

Development notes

  • Just missing few javadoc stuffs, we can use auto generated one for this in case these are trivial functions / variables.


 Comments   
Comment by Viet Nguyen [ 14/Apr/21 ]

[INFO] There are 9 errors reported by Checkstyle 8.19 with magnolia-build-resources/checkstyle.xml ruleset.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\client\AbstractSalesforceClientTest.java:[35] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\client\SalesforceClientProviderTest.java:[36] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\client\SalesforceClientTest.java:[39] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\forms\AllFieldsByFormIdTest.java:[40] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\forms\AllTest.java:[34] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\forms\ByIdTest.java:[33] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\forms\ByNameTest.java:[33] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\forms\ByRecordIdTest.java:[31] (javadoc) JavadocType: Missing a Javadoc comment.
[ERROR] src\test\java\info\magnolia\mkautomation\salesforce\leads\SearchByQueryTest.java:[37] (javadoc) JavadocType: Missing a Javadoc comment.

Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.1.0:check (default) on project magnolia-marketing-automation-salesforce-connector: You have 9 Checkstyle violations. -> [Help 1]

Comment by Viet Nguyen [ 27/Apr/21 ]

Development notes:
In case client wanna build this enterprise module. Pls follow maven setup as https://wiki.magnolia-cms.com/display/DEV/Maven+setup#Mavensetup-DXCoreprojectsettings (this does not have license clover) and I have to put manually from 52 to 69 as below img

Generated at Mon Feb 12 10:12:35 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.