Difference between revisions of "MVN Plugin"
(→Using Globalyzer Lite from the Command Prompt / Shell) |
|||
| Line 65: | Line 65: | ||
== Multi-Scan Projects == |
== Multi-Scan Projects == |
||
| − | == Sharing |
+ | == Sharing pom.xml Files Between IDEs and Build Systems == |
| − | It is common to check in a single |
+ | It is common to check in a single pom.xml per code repository. However, some configuration on a developer's laptop may be different from a build system. |
| + | A possibility to bridge the environment is to keep the most Globalyzer specific configuration only in the pom.xml file and to move the system side in the settings.xml file. |
||
| − | These incompatibilities are best solved by modifying the project definition file within the build system. The IDE config can then be used as the default. |
||
| − | |||
| − | Here is an example: The desired report type for Lite may be ScanDetailedCSV for developer usage, but will need to be ScanDetailedXML within the build system. The project definition file would then be written out with the <report-type> set to ScanDetailedCSV: |
||
| − | <pre><gzproject> |
||
| − | ... |
||
| − | <report-type>ScanDetailedCSV</report-type> |
||
| − | ... |
||
| − | </gzproject></pre> |
||
| − | |||
| − | The build system can then be set to auto-replace "ScanDetailedCSV" with "ScanDetailedXML". The following Linux command will do so: |
||
| − | |||
| − | <code>$ sed --in-place 's|ScanDetailedCSV|ScanDetailedXML|' $WORKSPACE/ProjectDefinition.xml</code> |
||
| − | |||
| − | If desired, the opposite replacement also may be performed at the end of the build. |
||
| − | |||
| − | Finally, here is a bash function to replace the content of any XML field: |
||
| − | |||
| − | <pre>replace_xml_token() { |
||
| − | token_name=$1 |
||
| − | new_content=$2 |
||
| − | sed -ri "s|(<${token_name}>).*(</${token_name}>)|\1${new_content}\2|g" $WORKSPACE/ProjectDefinition.xml |
||
| − | }</pre> |
||
| − | |||
| − | It may be used like so: |
||
| − | |||
| − | <code>$ replace_xml_token "report-type" "ScanDetailedXML"</code> |
||
| − | |||
| − | == Ease of Installation == |
||
| − | |||
| − | Installing Lite is easy. To install: |
||
| − | |||
| − | # Unzip the Globalyzer Lite zip file at a desired location |
||
| − | # Run either lite-setup.bat or lite-setup.sh depending on your system. |
||
| − | |||
| − | == Configuration & Rule Sets == |
||
| − | |||
| − | Before use of Globalyzer Lite, rule sets will need to be configured on the Globalyzer Server. Properly configured rule sets better detect i18n issues, and cut down the rate of false positives. |
||
| − | |||
| − | A Project Definition File will then need to be created for the given project. This file may be distributed to multiple users working on the same project. |
||
| − | |||
| − | The project definition file will need to make use of the correct rule sets relevant to the project, and to specify which directories to scan with each rule set. It is recommended that this file be configured by an i18n knowledgeable developer or i18n specialist. |
||
| − | |||
| − | == Project Definition Format== |
||
| − | |||
| − | Here is the template for a project definition file. For the full instructions to setup a project definition file, see our |
||
| − | [https://www.globalyzer.com/gzserver/help/referenceLite/project-definition-file-overview.html help page]. |
||
| − | |||
| − | <?xml version="1.0" encoding="UTF-8" standalone="no"?> |
||
| − | <!-- All items should be allowed anywhere in the xml as long as the hierarchy |
||
| − | is preserved --> |
||
| − | <gzproject> |
||
| − | <login> |
||
| − | <username></username> |
||
| − | <password></password> |
||
| − | <server></server> |
||
| − | <!-- Optional Parameters --> |
||
| − | <optional> |
||
| − | <proxy-user></proxy-user> |
||
| − | <proxy-password></proxy-password> |
||
| − | <proxy-host></proxy-host> |
||
| − | <proxy-port></proxy-port> |
||
| − | <optional> |
||
| − | </login> |
||
| − | <project-path></project-path> <!-- May instead be specified from command line --> |
||
| − | <project-name></project-name> |
||
| − | <report-path></report-path> <!-- May instead be specified from command line --> |
||
| − | <report-type></report-type> |
||
| − | <scans> |
||
| − | <scan> |
||
| − | <!-- create and execute a single scan with this info --> |
||
| − | <scan-name></scan-name> |
||
| − | <ruleset-name></ruleset-name> |
||
| − | <ruleset-owner></ruleset-owner> |
||
| − | </scan> |
||
| − | <scan> |
||
| − | <!-- create and execute a single scan with this info --> |
||
| − | <scan-name></scan-name> |
||
| − | <ruleset-name></ruleset-name> |
||
| − | <ruleset-owner></ruleset-owner> |
||
| − | <!-- optional: specify files/directories to scan --> |
||
| − | <scan-items> |
||
| − | <item></item> |
||
| − | <item></item> |
||
| − | </scan-items> |
||
| − | </scan> |
||
| − | </scans> |
||
| − | </gzproject> |
||
| − | |||
| − | == The .globalyzerrc File == |
||
| − | |||
| − | Globalyzer Lite supports an optional .globalyzerrc file. This file may be used to specify login, server, and proxy parameters. Below is an example .globalyzerrc file. It contains all parameters that may be set within the rc file: |
||
| − | |||
| − | <pre>server https://www.globalyzer.com/gzserver |
||
| − | |||
| − | username user@company.com |
||
| − | password aPasswordHere |
||
| − | |||
| − | proxy-host https://internalhost.company.com |
||
| − | proxy-port 81038 |
||
| − | proxy-user ExampleUser |
||
| − | proxy-password ExamplePassword</pre> |
||
| − | |||
| − | All settings besides 'server' are optional. And project definition files do not need to specify parameters set in the rc file (with one exception). Any parameter that is set in the project definition file will override the rc file setting. |
||
| − | |||
| − | If you choose to use a .globalyzerrc, the 'server' parameter is mandatory. It must match the server specified in project definition files. This helps prevent rule sets from being retrieved from the wrong server. |
||
| − | |||
| − | == Setting Proxy Settings via Java == |
||
| − | |||
| − | If you prefer to specify proxy settings via Java, rather than through the project definition file, you may use any of the following Java settings. |
||
| − | |||
| − | -Dhttp.proxyHost=your.server.com |
||
| − | -Dhttp.proxyPort=80 |
||
| − | -Dhttps.proxyHost=your.server.com |
||
| − | -Dhttps.proxyPort=80 |
||
| − | -Dhttp.nonProxyHosts=123.210.123.210 |
||
| − | -DsocksProxyHost=your.server.com |
||
| − | -DsocksProxyPort=1080 |
||
| − | |||
| − | More info at: https://docs.oracle.com/javase/7/docs/technotes/guides/net/proxies.html |
||
| − | |||
| − | == Exit Error Codes == |
||
| − | {| style="text-align: left;" |
||
| − | |- style="font-size: 125%;" |
||
| − | ! colspan="2" | Type |
||
| − | |- |
||
| − | ! Name !! style="padding-left: 15px;" | Exit Code |
||
| − | |- |
||
| − | | || |
||
| − | |||
| − | |- style="font-size: 125%;" |
||
| − | ! colspan="2" | Normal |
||
| − | |- |
||
| − | | EXIT_NORMAL || style="padding-left: 15px;" | 0 |
||
| − | |- |
||
| − | | || |
||
| − | |||
| − | |- style="font-size: 125%;" |
||
| − | ! colspan="2" |XML Issues |
||
| − | |- |
||
| − | |NO_PATH_TO_XML_FILE || style="padding-left: 15px;" | 10 |
||
| − | |- |
||
| − | | DUPLICATE_PARAMETER_IN_XML || style="padding-left: 15px;" | 11 |
||
| − | |- |
||
| − | | XML_PARAMETER_BLANK || style="padding-left: 15px;" | 12 |
||
| − | |- |
||
| − | | XML_INVALID_PARAMETER || style="padding-left: 15px;" | 13 |
||
| − | |- |
||
| − | | UNABLE_TO_READ_SCHEMA || style="padding-left: 15px;" | 14 |
||
| − | |- |
||
| − | | || |
||
| − | |||
| − | |- style="font-size: 125%;" |
||
| − | ! colspan="2" | Globalyzer API compatibility |
||
| − | |- |
||
| − | | GLOBALYZER_API_REPORT_TYPE_NOT_MATCHED || style="padding-left: 15px;" | 30 |
||
| − | |- |
||
| − | | GLOBALYZER_API_EXCEPTION || style="padding-left: 15px;" | 31 |
||
| − | |- style="height:20px" |
||
| − | |- |
||
| − | | || |
||
| − | |||
| − | |- style="font-size: 125%;" |
||
| − | ! colspan="2" | Input issues |
||
| − | |- |
||
| − | | IMPROPER_INPUT || style="padding-left: 15px;" | 51 |
||
| − | |- |
||
| − | | INVALID_COMMANDS || style="padding-left: 15px;" | 52 |
||
| − | |- |
||
| − | | PROJECT_PATH_DOES_NOT_EXIST || style="padding-left: 15px;" | 53 |
||
| − | |- |
||
| − | | || |
||
| − | |||
| − | |- style="font-size: 125%;" |
||
| − | ! colspan="2" | Output Issues |
||
| − | |- |
||
| − | | SCAN_FAILED || style="padding-left: 15px;" | 60 |
||
| − | |} |
||
| − | |||
| − | == Language Support == |
||
| − | Globalyzer Lite supports the same languages as the full Globalyzer product. It allows users to scan a number of source code in different programming languages: |
||
| − | * ActionScript, |
||
| − | * C#, |
||
| − | * C/C++ (many variations), |
||
| − | * Delphi, |
||
| − | * HTML (in various web files), |
||
| − | * Java, |
||
| − | * JavaScript, (includes AngularJS, NodeJS, and other libraries) |
||
| − | * Objective-C, |
||
| − | * MXML, |
||
| − | * Perl, |
||
| − | * PHP, |
||
| − | * Qt, |
||
| − | * SQL (Oracle, MS SQL, MySQL, PostgreSQL), |
||
| − | * Visual Basic (Classic, .NET), |
||
| − | * VBScript, and |
||
| − | * XML |
||
| − | |||
| − | == Lite vs the Globalyzer API == |
||
| − | |||
| − | Globalyzer Lite utilizes the Globalyzer API. Using the API directly is more powerful, but also requires writing a custom java application. |
||
| − | |||
| − | == Lite vs the Globalyzer Workbench == |
||
| − | |||
| − | In comparison to the Globalyzer Workbench, Globalyzer Lite is smaller, faster to install and does not require a database. Lite supports direct integration with IDEs, while the Workbench is its own standalone program. Additionally, unlike the workbench, multiple instances of Lite may be run concurrently. This allows Continuous Integration systems to use Lite to provision the scanning of multiple projects. |
||
Revision as of 17:37, 6 September 2016
Globalyzer has a number of clients: The Workbench, the command line interface, Lite, the Ant client, and the MVN plugin. When using a MVN project, you can add code scanning with Globalyzer using our MVN plugin. It is well suited for use within automation routines and Continuous Integration (CI) systems as well as within a typical developer environment, for instance within an Integrated Development Environments (IDEs).
The Globalyzer MVN plugin generates scan reports to a directory specified the pom.xml file. Scan reports are available in a variety of formats. We ask our MVN customers to install the MVN plugin in a private MVN repository for that company.
The steps to use the Globalyzer MVN plugin are the same as any MVN plugin:
- Install the plugin
- Configure the pom.xml
- Run MVN
Contents
Install the Globalyzer MVN Plugin
For those customers who require the MVN plugin, we make the globalyzer-mvn-plugin-x.y.z.jar file available for download. We ask that this jar file be installed in a private MVN repository at the customer's side.
Configure the Globalyzer MVN Plugin
The <build><plugins> section of your module's pom.xml file must be configured. Here is how:
<plugin>
<groupId>com.lingoport.globalyzer.client.maven</groupId>
<artifactId>globalyzer-maven-plugin</artifactId>
<version>5.2.1</version>
<configuration>
-required-
<username>joe@company.com</username>
<password>joespw</password>
<ruleSetName>Java Rule Set</ruleSetName>
-optional-
<serverUrl></serverUrl> (default: https://www.globalyzer.com/gzserver)
<dataDictionaryDir></dataDictionaryDir> ( default: userhome/.globalyzer )
<projectName></projectName> ( default: project artifact )
<projectDir></projectDir> ( default: project src/main/java )
<ruleSetOwner></ruleSetOwner> ( default: username )
<scanName></scanName> ( default: auto-generate )
<scanTimeout></scanTimeout> ( default: 120 seconds )
<filterWithDictionary></filterWithDictionary> ( default: true )
<reportType></reportType> ( default: ScanDetailedXML )
<reportPath></reportPath> ( default: target/i18n )
<setLog4jProperties></setLog4jProperties> ( default: true )
<log4jPropertiesFileDir></log4jPropertiesFileDir> ( default: Globalyzer provided )
</configuration>
</plugin>
Running Globalyzer MVN Plugin From The Command Prompt / Shell
Globalyzer MVN Plugin can be executed from a command prompt or shell via the following command:
mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2:scan
After MVN finishes each scan, a Globalyzer report per scan is created at the location specified in the pom.xml report path. The default location for the reports are target/i18n for each MVN module.
Multi-Threaded Support
The Globalyzer MVN plugin supports multi-threaded invocation. For instance, on multi-module projects, use the -T option. For instance:
mvn com.lingoport.globalyzer.client.maven:globalyzer-maven-plugin:5.2:scan -T3c
Multi-Scan Projects
Sharing pom.xml Files Between IDEs and Build Systems
It is common to check in a single pom.xml per code repository. However, some configuration on a developer's laptop may be different from a build system.
A possibility to bridge the environment is to keep the most Globalyzer specific configuration only in the pom.xml file and to move the system side in the settings.xml file.
