command line interface - support.squoring.com · squore 14-b-sp4 command line interface reference :...

Squore 14-B-SP4Command Line Interface

Reference : SUM_Squore_CLIVersion : 14-B-SP4Date : 10/06/2015

Squoring Technologies76, allées Jean Jaurès / 31000 Toulouse - FRANCE / Tel. +33 581 346 397

http://www.squoring.com/APE 5829 C - SIREN 521171629 – RCS Toulouse

Command Line InterfaceCopyright © 2015 Squoring Technologies

AbstractThis edition of the Command Line Interface applies to Squore 14-B-SP4 and to all subsequent releases andmodifications until otherwise indicated in new editions.

LicenceNo part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computerlanguage, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the priorwritten permission of the copyright owner, Squoring Technologies.

Squoring Technologies reserves the right to revise this publication and to make changes from time to time without obligation to notifyauthorised users of such changes. Consult Squoring Technologies to determine whether any such changes have been made.

The terms and conditions governing the licensing of Squoring Technologies software consist solely of those set forth in the writtencontracts between Squoring Technologies and its customers.

All third-party products are trademarks or registered trademarks of their respective companies.

WarrantySquoring Technologies makes no warranty of any kind with regard to this material, including, but not limited to, the implied warrantiesof merchantability and fitness for a particular purpose. Squoring Technologies shall not be liable for errors contained herein nor forincidental or consequential damages in connection with the furnishing, performance or use of this material.

Command Line Interface

iiiRef : SUM_Squore_CLI

Version : 14-B-SP4Date : 10/06/2015

http://www.squoring.com/© 2015 Squoring Technologies All rights reserved. This material may not be reproduced, displayed, modified or distributed without the express prior written permission of the copyright holder. Squore

is protected by an Interdeposit Certification registered with Agence pour la Protection des Programmes under the Inter Deposit Digital Number IDDN.FR.001.390035.0005.000.S.P.2013.000.10600.

Table of ContentsTypographical Conventions .................................................................................................... viiiAcronyms and Abbreviations ................................................................................................... ix

1. Introduction ........................................................................................................................ 11.1. Foreword ........................................................................................................................ 11.2. About This Document ....................................................................................................... 11.3. Contacting Squoring Technologies Product Support ............................................................... 11.4. Responsabilities ............................................................................................................... 11.5. Getting the Latest Version of this Manual ............................................................................ 2

2. Getting Started With the Squore CLI .................................................................................... 32.1. Installation Prerequisites ................................................................................................... 32.1.1. Supported Operating Systems ......................................................................................... 32.1.2. For All Systems ............................................................................................................. 32.1.3. Packages for Windows ................................................................................................... 32.1.4. Packages for Linux ......................................................................................................... 42.2. Deploying Squore CLI ....................................................................................................... 52.2.1. On Windows ................................................................................................................ 52.2.2. On Linux .................................................................................................................... 102.2.3. Third-Party Plugins and Applications ............................................................................... 112.2.4. Post Installation Actions ............................................................................................... 112.3. Saving Credentials to Disk ................................................................................................ 122.4. Running The Sample Scripts ............................................................................................. 132.5. Squore in a Continuous Integration Environment ................................................................. 13

3. Command Line Reference .................................................................................................. 153.1. Squore CLI Commands .................................................................................................... 153.2. Squore CLI Parameters .................................................................................................... 163.3. Project Parameters ......................................................................................................... 163.4. Exit Codes ..................................................................................................................... 18

4. Repository Connectors ....................................................................................................... 194.1. Folder Path ................................................................................................................... 194.2. Zip File ......................................................................................................................... 194.3. ClearCase ...................................................................................................................... 194.4. CVS .............................................................................................................................. 194.5. Git ............................................................................................................................... 204.6. MKS ............................................................................................................................. 204.7. Perforce ....................................................................................................................... 204.8. SVN ............................................................................................................................. 214.9. Synergy ........................................................................................................................ 214.10. TFS ............................................................................................................................. 224.11. Using Multiple Nodes .................................................................................................... 224.12. Using Data Provider Input Files From Version Control ......................................................... 22

5. Data Providers .................................................................................................................. 245.1. AntiC ............................................................................................................................ 245.1.1. Description ................................................................................................................. 245.1.2. Measures ................................................................................................................... 245.1.3. Usage ........................................................................................................................ 245.2. Bullseye Code Coverage .................................................................................................. 245.2.1. Description ................................................................................................................. 245.2.2. Measures ................................................................................................................... 245.2.3. Usage ........................................................................................................................ 245.3. CPD ............................................................................................................................. 25


ivRef : SUM_Squore_CLI




5.3.1. Description ................................................................................................................. 255.3.2. Measures ................................................................................................................... 255.3.3. Usage ........................................................................................................................ 255.4. CPD (plugin) .................................................................................................................. 255.4.1. Description ................................................................................................................. 255.4.2. Measures ................................................................................................................... 255.4.3. Usage ........................................................................................................................ 255.5. CPPCheck ...................................................................................................................... 265.5.1. Description ................................................................................................................. 265.5.2. Measures ................................................................................................................... 265.5.3. Usage ........................................................................................................................ 265.6. CPPCheck (plugin) .......................................................................................................... 265.6.1. Description ................................................................................................................. 265.6.2. Measures ................................................................................................................... 265.6.3. Usage ........................................................................................................................ 275.7. CPPTest ........................................................................................................................ 275.7.1. Description ................................................................................................................. 275.7.2. Measures ................................................................................................................... 275.7.3. Usage ........................................................................................................................ 275.8. CheckStyle .................................................................................................................... 275.8.1. Description ................................................................................................................. 275.8.2. Measures ................................................................................................................... 275.8.3. Usage ........................................................................................................................ 285.9. CheckStyle (plugin) ......................................................................................................... 285.9.1. Description ................................................................................................................. 285.9.2. Measures ................................................................................................................... 285.9.3. Usage ........................................................................................................................ 285.10. CheckStyle for SQALE (plugin) ......................................................................................... 285.10.1. Description ............................................................................................................... 285.10.2. Measures .................................................................................................................. 295.10.3. Usage ....................................................................................................................... 295.11. CodeSonar ................................................................................................................... 295.11.1. Description ............................................................................................................... 295.11.2. Measures .................................................................................................................. 295.11.3. Usage ....................................................................................................................... 305.12. Coverity ...................................................................................................................... 305.12.1. Description ............................................................................................................... 305.12.2. Measures .................................................................................................................. 305.12.3. Usage ....................................................................................................................... 305.13. FindBugs ..................................................................................................................... 315.13.1. Description ............................................................................................................... 315.13.2. Measures .................................................................................................................. 315.13.3. Usage ....................................................................................................................... 315.14. FindBugs (plugin) .......................................................................................................... 315.14.1. Description ............................................................................................................... 315.14.2. Measures .................................................................................................................. 315.14.3. Usage ....................................................................................................................... 315.15. FxCop ......................................................................................................................... 325.15.1. Description ............................................................................................................... 325.15.2. Measures .................................................................................................................. 325.15.3. Usage ....................................................................................................................... 325.16. GCov .......................................................................................................................... 325.16.1. Description ............................................................................................................... 32


vRef : SUM_Squore_CLI




5.16.2. Measures .................................................................................................................. 325.16.3. Usage ....................................................................................................................... 325.17. GnatCheck ................................................................................................................... 335.17.1. Description ............................................................................................................... 335.17.2. Measures .................................................................................................................. 335.17.3. Usage ....................................................................................................................... 335.18. GnatCompiler .............................................................................................................. 335.18.1. Description ............................................................................................................... 335.18.2. Measures .................................................................................................................. 335.18.3. Usage ....................................................................................................................... 335.19. JUnit .......................................................................................................................... 345.19.1. Description ............................................................................................................... 345.19.2. Measures .................................................................................................................. 345.19.3. Usage ....................................................................................................................... 345.20. Jacoco ........................................................................................................................ 345.20.1. Description ............................................................................................................... 345.20.2. Measures .................................................................................................................. 345.20.3. Usage ....................................................................................................................... 345.21. Klocwork ..................................................................................................................... 355.21.1. Description ............................................................................................................... 355.21.2. Measures .................................................................................................................. 355.21.3. Usage ....................................................................................................................... 355.22. NCover ....................................................................................................................... 355.22.1. Description ............................................................................................................... 355.22.2. Measures .................................................................................................................. 355.22.3. Usage ....................................................................................................................... 355.23. Oracle PLSQL compiler Warning checker ........................................................................... 365.23.1. Description ............................................................................................................... 365.23.2. Measures .................................................................................................................. 365.23.3. Usage ....................................................................................................................... 365.24. MISRA Rule Checking using PC Lint .................................................................................. 365.24.1. Description ............................................................................................................... 365.24.2. Measures .................................................................................................................. 365.24.3. Usage ....................................................................................................................... 365.25. PMD ........................................................................................................................... 375.25.1. Description ............................................................................................................... 375.25.2. Measures .................................................................................................................. 375.25.3. Usage ....................................................................................................................... 375.26. PMD (plugin) ............................................................................................................... 375.26.1. Description ............................................................................................................... 375.26.2. Measures .................................................................................................................. 375.26.3. Usage ....................................................................................................................... 375.27. Polyspace .................................................................................................................... 385.27.1. Description ............................................................................................................... 385.27.2. Measures .................................................................................................................. 385.27.3. Usage ....................................................................................................................... 385.28. MISRA Rule Checking using Polyspace .............................................................................. 385.28.1. Description ............................................................................................................... 385.28.2. Measures .................................................................................................................. 385.28.3. Usage ....................................................................................................................... 385.29. Polyspace (plugin) ........................................................................................................ 395.29.1. Description ............................................................................................................... 395.29.2. Measures .................................................................................................................. 39


viRef : SUM_Squore_CLI




5.29.3. Usage ....................................................................................................................... 395.30. MISRA Rule Checking from QAC ...................................................................................... 395.30.1. Description ............................................................................................................... 395.30.2. Measures .................................................................................................................. 395.30.3. Usage ....................................................................................................................... 395.31. Unit Test Code Coverage from Rational Test RealTime ........................................................ 405.31.1. Description ............................................................................................................... 405.31.2. Measures .................................................................................................................. 405.31.3. Usage ....................................................................................................................... 405.32. ReqIf .......................................................................................................................... 405.32.1. Description ............................................................................................................... 405.32.2. Measures .................................................................................................................. 405.32.3. Usage ....................................................................................................................... 405.33. SQLCodeGuard ............................................................................................................. 415.33.1. Description ............................................................................................................... 415.33.2. Measures .................................................................................................................. 415.33.3. Usage ....................................................................................................................... 415.34. SQuORE ...................................................................................................................... 415.34.1. Description ............................................................................................................... 415.34.2. Measures .................................................................................................................. 415.34.3. Usage ....................................................................................................................... 425.35. SQuORE Import ............................................................................................................ 435.35.1. Description ............................................................................................................... 435.35.2. Measures .................................................................................................................. 435.35.3. Usage ....................................................................................................................... 435.36. SQuORE Virtual Project .................................................................................................. 435.36.1. Description ............................................................................................................... 435.36.2. Measures .................................................................................................................. 435.36.3. Usage ....................................................................................................................... 435.37. StyleCop ..................................................................................................................... 445.37.1. Description ............................................................................................................... 445.37.2. Measures .................................................................................................................. 445.37.3. Usage ....................................................................................................................... 445.38. StyleCop (plugin) .......................................................................................................... 445.38.1. Description ............................................................................................................... 445.38.2. Measures .................................................................................................................. 445.38.3. Usage ....................................................................................................................... 445.39. Tessy .......................................................................................................................... 445.39.1. Description ............................................................................................................... 455.39.2. Measures .................................................................................................................. 455.39.3. Usage ....................................................................................................................... 455.40. oslc cm ....................................................................................................................... 455.40.1. Description ............................................................................................................... 455.40.2. Measures .................................................................................................................. 455.40.3. Usage ....................................................................................................................... 455.41. pep8 .......................................................................................................................... 465.41.1. Description ............................................................................................................... 465.41.2. Measures .................................................................................................................. 465.41.3. Usage ....................................................................................................................... 465.42. pylint .......................................................................................................................... 465.42.1. Description ............................................................................................................... 465.42.2. Measures .................................................................................................................. 465.42.3. Usage ....................................................................................................................... 46


viiRef : SUM_Squore_CLI




A. Reference pages ............................................................................................................... 47install ................................................................................................................................. 47

Index .................................................................................................................................... 48


viiiRef : SUM_Squore_CLI




Typographical ConventionsThe following conventions are used in this manual.

Typeface or Symbol Meaning

Bold Book titles, important items, or items that can beselected including buttons and menu choices. Forexample: Click Next > to continue

Italic A name of a user defined textual element. Forexample: Username : admin

Courier New Files and directories; file extensions, computeroutput. For example: Edit the config.xml file

Courier Bold Commands, screen messages requiring user action.For example: Username : admin

> Menu choices. For example: Select File > Open .This means select the File menu, then select the Opencommand from it.

<...> Generic terms. For example: <INSTALLDIR> refersto the Squore installation directory.

Notes

Screenshots displayed in this manual may differ slightly from the ones in the actual product.


ixRef : SUM_Squore_CLI




Acronyms and AbbreviationsThe following acronyms and abbreviations are used in this manual.

CI Continuous Integration

CLI Command Line Interface

DP Data Provider, a Squore module capable of handlinginput from various other systems and importinformation into Squore

RC Repository Connector, a Squore module capableof extracting source code from source codemanagement systems.


1Ref : SUM_Squore_CLI




1. Introduction1.1. Foreword

This document was released by Squoring Technologies.

It is part of the user documentation of the Squore software product edited and distributed by SquoringTechnologies.

1.2. About This DocumentThis document is the Command Line Interface Guide for Squore.

It is indented as a follow up to the Squore Getting Started Guide and will help you understand how to useSquore CLI to create and update projects. It is divided into several chapters, as detailed below:

Chapter 2, Getting Started With the Squore CLI provides a basic introduction to Squore CLI and the examplesprovided with your Squore installation.

Chapter 3, Command Line Reference provides a complete reference of all the command line options andparameters for creating projects.

Chapter 4, Repository Connectors covers the default Repository Connectors and the parameters to pass toSquore to use them.

Chapter 5, Data Providers is a reference guide to all the Data Providers shipped with Squore.

For information on how to use and configure Squore, the following manuals are also available:

Squore Installation and Administration Guide,

Squore Getting Started Guide,

Squore Configuration Guide,

Squore Reference Manual.

1.3. Contacting Squoring Technologies Product SupportIf the information provided in this manual is erroneous or inaccurate, or if you encounter problems duringyour installation, contact Squoring Technologies Product Support: http://support.squoring.com/

You will need a valid Squore customer account to submit a support request. You can create an account onthe support website if you do not have one already.

For any communication:

[email protected]

Squoring Technologies Product Support76, allées Jean Jaurès / 31000 Toulouse - FRANCE

1.4. ResponsabilitiesApproval of this version of the document and any further updates are the responsibility of SquoringTechnologies.

http://support.squoring.com/






1.5. Getting the Latest Version of this ManualThe version of this manual included in your Squore installation may have been updated. If you wouldlike to check for updated user guides, consult the Squoring Technologies documentation site to consult ordownload the latest Squore manuals at http://support.squoring.com//documentation/14-B-SP4. Manuals areconstantly updated and published as soon as they are available.

http://support.squoring.com//documentation/14-B-SP4






2. Getting Started With the Squore CLISquore CLI is a package that is installed on every client computer that needs to perform local code analyses ortrigger a remote analysis on Squore Server. It contains the client (squore-engine.jar), its libraries, configurationfiles and some sample job files to help you get started. In this section, you will learn more about the differentsetup configurations supported by the CLI, its installation and integration into a Continuous Integrationenvironment.

2.1. Installation PrerequisitesThe CLI accepts commands and parameters to communicate with Squore Server. Inside the installation folder,some scripts are provided as examples to create projects, save enctypted credentials to disk, and synchronisethe client's configuration with the server.

There are two ways to contemplate the CLI deployment:

1. As a way to analyse code and process data on a client machine and send the results to the server.2. As a way to instruct the server to carry out an analysis of code and other input data.

2.1.1. Supported Operating SystemsThe following is a list of the officially supported operating systems for Squore CLI:

CentOS 6Fedora 19RedHat EL 5RedHat EL 6SuSe Linux 11.1Ubuntu Server 10.04Ubuntu Server 13.04Windows 7Windows 8Windows Server 2008 R2

2.1.2. For All SystemsFor a successful installation of Squore CLI, you will need:

The latest version of the Squore CLI installer, which can be download from http://support.squoring.com/download_area.phpA user account with system administrator privilegesThe Oracle Java Runtime Environment version 1.6.0_45 or higherAt least 2 GB of space available on the disk for a full installationAt least 4 GB of RAM on the machineThe java executable should be in the machine's PATH envrironment variable.

2.1.3. Packages for WindowsA JRE is required. The Windows installer contains the tcl and perl runtimes needed. It will allow you to obtainthe configuration needed to create projects from the server.

http://support.squoring.com/download_area.php

http://support.squoring.com/download_area.php






2.1.4. Packages for LinuxOn Linux platforms, the following must be installed before installing Squore CLI:

Perl version 5.10.1 or greater including the following extra-modules:

Mandatory packages:

Archive::Zip [module details] [http://search.cpan.org/~phred/Archive-Zip/lib/Archive/Zip.pm]

Algorithm::Diff [module details] [http://search.cpan.org/~nedkonz/Algorithm-Diff/lib/Algorithm/Diff.pm]

Date::Calc (since 14-A-SP2) [module details] [http://search.cpan.org/~stbey/Date-Calc/lib/Date/Calc.pod]

DBI [module details] [http://search.cpan.org/~timb/DBI/DBI.pm]

DBD::Pg [module details] [http://search.cpan.org/~turnstep/DBD-Pg/Pg.pm]

Digest::SHA [module details] [http://search.cpan.org/~mshelor/Digest-SHA/lib/Digest/SHA.pm]

HTTP::Request [module details] [http://search.cpan.org/~gaas/HTTP-Message/lib/HTTP/Request.pm]

JSON [module details] [http://search.cpan.org/~makamaka/JSON/lib/JSON.pm]

LWP::UserAgent [module details] [http://search.cpan.org/~gaas/libwww-perl/lib/LWP/UserAgent.pm]

LWP::Protocol::https [module details] [http://search.cpan.org/~gaas/LWP-Protocol-https/lib/LWP/Protocol/https.pm]

Time::HiRes [module details] [http://search.cpan.org/~zefram/Time-HiRes/HiRes.pm]

XML::Parser [module details] [http://search.cpan.org/~toddr/XML-Parser/Parser.pm]

Optional packages for working with Microsoft Excel:

Spreadsheet::XLSX [module details] [http://search.cpan.org/~dmow/Spreadsheet-XLSX/lib/Spreadsheet/XLSX.pm]

Spreadsheet::WriteExcel [module details] [http://search.cpan.org/~jmcnamara/Spreadsheet-WriteExcel/lib/Spreadsheet/WriteExcel.pm]

Spreadsheet::ParseExcel [module details] [http://search.cpan.org/~jmcnamara/Spreadsheet-ParseExcel/lib/Spreadsheet/ParseExcel.pm]

Spreadsheet::BasicRead [module details] [http://search.cpan.org/~gng/Spreadsheet-BasicRead/BasicRead.pm]

HTML::Entities (since 14-A-SP3) [module details] [http://search.cpan.org/dist/HTML-Parser/lib/HTML/Entities.pm]

OLE::Storage_Lite::PPS [module details] [http://search.cpan.org/~jmcnamara/OLE-Storage_Lite/lib/OLE/Storage_Lite.pm]

Digest::Perl::MD5 [module details] [http://search.cpan.org/~delta/Digest-Perl-MD5/lib/Digest/Perl/MD5.pm]

Crypt::RC4 [module details] [http://search.cpan.org/~sifukurt/Crypt-RC4/RC4.pm]

Optional packages for working with OSLC systems:

HTML::TreeBuilder [module details] [http://search.cpan.org/~cjm/HTML-Tree/lib/HTML/TreeBuilder.pm]

HTTP::Server::Simple [module details] [http://search.cpan.org/~jesse/HTTP-Server-Simple/lib/HTTP/Server/Simple.pm]

http://search.cpan.org/~phred/Archive-Zip/lib/Archive/Zip.pm

http://search.cpan.org/~phred/Archive-Zip/lib/Archive/Zip.pm

http://search.cpan.org/~nedkonz/Algorithm-Diff/lib/Algorithm/Diff.pm



http://search.cpan.org/~stbey/Date-Calc/lib/Date/Calc.pod



http://search.cpan.org/~timb/DBI/DBI.pm

http://search.cpan.org/~timb/DBI/DBI.pm

http://search.cpan.org/~turnstep/DBD-Pg/Pg.pm

http://search.cpan.org/~turnstep/DBD-Pg/Pg.pm

http://search.cpan.org/~mshelor/Digest-SHA/lib/Digest/SHA.pm

http://search.cpan.org/~mshelor/Digest-SHA/lib/Digest/SHA.pm

http://search.cpan.org/~gaas/HTTP-Message/lib/HTTP/Request.pm



http://search.cpan.org/~makamaka/JSON/lib/JSON.pm

http://search.cpan.org/~makamaka/JSON/lib/JSON.pm

http://search.cpan.org/~gaas/libwww-perl/lib/LWP/UserAgent.pm



http://search.cpan.org/~gaas/LWP-Protocol-https/lib/LWP/Protocol/https.pm



http://search.cpan.org/~zefram/Time-HiRes/HiRes.pm

http://search.cpan.org/~zefram/Time-HiRes/HiRes.pm

http://search.cpan.org/~toddr/XML-Parser/Parser.pm

http://search.cpan.org/~toddr/XML-Parser/Parser.pm

http://search.cpan.org/~dmow/Spreadsheet-XLSX/lib/Spreadsheet/XLSX.pm



http://search.cpan.org/~jmcnamara/Spreadsheet-WriteExcel/lib/Spreadsheet/WriteExcel.pm



http://search.cpan.org/~jmcnamara/Spreadsheet-ParseExcel/lib/Spreadsheet/ParseExcel.pm



http://search.cpan.org/~gng/Spreadsheet-BasicRead/BasicRead.pm



http://search.cpan.org/dist/HTML-Parser/lib/HTML/Entities.pm



http://search.cpan.org/~jmcnamara/OLE-Storage_Lite/lib/OLE/Storage_Lite.pm



http://search.cpan.org/~delta/Digest-Perl-MD5/lib/Digest/Perl/MD5.pm



http://search.cpan.org/~sifukurt/Crypt-RC4/RC4.pm

http://search.cpan.org/~sifukurt/Crypt-RC4/RC4.pm

http://search.cpan.org/~cjm/HTML-Tree/lib/HTML/TreeBuilder.pm



http://search.cpan.org/~jesse/HTTP-Server-Simple/lib/HTTP/Server/Simple.pm








HTTP::Server::Simple::CGI [module details] [http://search.cpan.org/~jesse/HTTP-Server-Simple/lib/HTTP/Server/Simple/CGI.pm]

WWW::Mechanize [module details] [http://search.cpan.org/~ether/WWW-Mechanize/lib/WWW/Mechanize.pm]

Date::Parse [module details] [http://search.cpan.org/~gbarr/TimeDate/lib/Date/Parse.pm]

Date::Language [module details] [http://search.cpan.org/~gbarr/TimeDate/lib/Date/Language.pm]

Date::Format [module details] [http://search.cpan.org/~gbarr/TimeDate/lib/Date/Format.pm]

Time::Zone [module details] [http://search.cpan.org/~gbarr/TimeDate/lib/Time/Zone.pm]

TipIf some of these modules are not available as packages on your operating system, use your perlinstallation's cpan to install the modules. Using the os packages is recommended, as it avoidshaving to reinstall via cpan after upgrading your version of perl.

Tcl version 8.5 or greater

2.2. Deploying Squore CLINote that Oracle's Java Runtime Environment (minimum version 1.6) is required on the client machine forthe CLI to run.

2.2.1. On WindowsAfter verifying that you meet the prerequisites detailed in Section 2.1, “Installation Prerequisites”, log on withan account that has administrator privileges and launch Squore CLI installer. Each of the wizard screens isdocumented below in the order that you will see them.

WarningThe data and temporary folders must be excluded from the scope of virus scanners, malwareprotectors and search indexers to avoid any errors during an analysis.

1. Squore CLI installer Welcome screen

http://search.cpan.org/~jesse/HTTP-Server-Simple/lib/HTTP/Server/Simple/CGI.pm



http://search.cpan.org/~ether/WWW-Mechanize/lib/WWW/Mechanize.pm



http://search.cpan.org/~gbarr/TimeDate/lib/Date/Parse.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Date/Parse.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Date/Language.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Date/Language.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Date/Format.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Date/Format.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Time/Zone.pm

http://search.cpan.org/~gbarr/TimeDate/lib/Time/Zone.pm






Squore CLI installer Welcome screen

On the Welcome screen, click the Next to start the installation.

2. Squore CLI licence agreement screen






Squore CLI licence agreement screen

Click the I Agree button after reviewing the terms of the licence to continue the installation.

3. Squore CLI components screen






Squore CLI components screen

Select the components you want to install and click Next to proceed to the next setp of the installation.

4. Squore CLI destination folder screen






Squore CLI destination folder screen

Browse for the folder where you want to deploy Squore CLI and click Next to proceed to the next setpof the installation.

5. Squore CLI installation parameters screen






Squore CLI installation parameters screen

Specify the path of the JDK installation (a JRE is also supported) on your system. Specify the details ofSquore Server that the client should connect to. if you check the Update and synchronise withserver box, the installer will attempt to retrieve the up-to-date client binaries from the server as wellas the configuration. Click Next to start copying the installation files onto your hard disk.

If an error happens during the installation process, a log file is available in the destination folder you selectedduring the installation.

2.2.2. On LinuxBefore installing Squore CLI on a Linux platform, verify that all prerequisites are met, as described inSection 2.1, “Installation Prerequisites”

1. Unzip the squore-cli-linux-14-B-SP4.<buildNumber>.tar.bz2 archive file and thenextract the content of the tar file in <INSTALLDIR>: i.e. the selected Squore installation directory.tar xjf squore-cli-linux-14-B-SP4.<buildNumber>.tar.bz2

<INSTALLDIR> now contains a new folder called squore-cli, for example: /home/user/squore-cli.

2. Run the installation script in a command shell:<INSTALLDIR>/bin/install -v -s http://localhost:8180/SQuORE_Server -u user -p password

For more details on install options, refer to install(1).






TipWhen installing Squore CLI, a connection to Squore Server is automatically attempted to retrieve themost up-to-date client and configuration. You can disable this synchronisation attempt by passing-N to the installation script.

2.2.3. Third-Party Plugins and ApplicationsIf you have deployed some third-party tools on Squore Server, they will automatically be downloaded to yourclient when you launch the client synchronisation script.

On Linux, some plugins may still need your attention: Cppcheck must be installed and available in the path,and antiC must be compiled with the command:

# cd <INSTALLDIR>/addons/Antic_auto/bin/ && gcc antic.c -o antic

For more information, refer to the Command Line Interface Manual, which contains the full details aboutspecial installation procedures for data providers and repository connectors.

2.2.4. Post Installation ActionsAfter the CLI installation is successful, you can familiarise yourself will the structure of the installationdirectory:

<INSTALLDIR>/addons A folder containing the data providers of the product.

<INSTALLDIR>/bin A folder containing sample projects creation scripts and utilities.

<INSTALLDIR>/configuration A configuration of the product containing the tools, wizards and analysismodels.

<INSTALLDIR>/docs A folder containing the Command Line Interface manual.

<INSTALLDIR>/lib A folder containing the main engine and its client libraries.

<INSTALLDIR>/samples A folder containing sample source code to be used with the sample launcherssupplied in <INSTALLDIR>/bin.

<INSTALLDIR>/share: A folder containing specific perl libraries used by the CLI to launch jobs.

<INSTALLDIR>/tools A folder containing the perl and tclsh distributions on Windows. This folder does notexist in the Linux version, since the system installations of perl and tclsh are used.

<INSTALLDIR>/config.xml An XML configuration file that the CLI uses to find its configuration.

TipAfter installing Squore CLI, the credentials for the user you specified during the installation have beensaved, and the scripts in <INSTALLDIR>/bin will use the username and password specified.

The file config.xml contains information about the Squore CLI installation.. Here is the defaultconfig.xml:

<?xml version="1.0" encoding="utf-8" standalone="yes"?><squore type="client" version="1.1"> <paths> <path name="perl.dir" path="path/to/perl"/> <path name="tclsh.dir" path="path/to/tclsh"/> </paths> <configuration> <path directory="<INSTALLDIR>/configuration"/>






</configuration> <addons> <path directory="<INSTALLDIR>/addons"/> </addons></squore>

You can extend your config.xml by specifying where you want the temporary and data files to be storedon your system, as shown below:

Folder used to store temporary log files:<tmp directory="/tmp/squore-${user.name}"/>

Folder used to run analyses and store project files before they are sent to the server:<projectsdirectory="${user.home}/.squore/projects"/>

Folder used when extracting files from SCM systems:<sources directory="${java.io.tmpdir}/sources"/>

Using java system properties to specify the paths to the tmp, projects and sources folders is useful ifyou want the Squore CLI installation to work for multiple users. Note that all three elements are optional, andwill use the values shown above by default if you do not specify them in config.xml.

Here is an example of a full config.xml:

<?xml version="1.0" encoding="utf-8" standalone="yes"?><squore type="client" version="1.1> <paths> <path name="perl.dir" path="path/to/perl"/> <path name="tclsh.dir" path="path/to/tclsh"/> </paths> <configuration> <path directory="<INSTALLDIR>/configuration"/> </configuration> <addons> <path directory="<INSTALLDIR>/addons"/> </addons> <tmp directory="/tmp/squore-${user.name}"/> <projects directory="${user.home}/.squore/projects"/> <sources directory="${java.io.tmpdir}/sources"/></squore>

TipNote that all three folders can be cleaned up regularly when no analysis is running.

2.3. Saving Credentials to DiskSquore CLI includes a small utility called add-credentials.sh that can save your credentials to disk. This avoidstyping your password every time you create a project, and also avoids having to save the password in yourscript files.

add-credentials.sh is located in <INSTALLDIR>/bin and allows saving passwords for Squore users and thevarious repository connectors known to Squore. To start saving credentials, simply run add-credentials.sh.You are presented with a choice of several types of credentials you can save:






Available credentials types in add-credentials.sh

In order to save user credentials for Squore Server, select 1, then type the login and associated password.

In order to save credentials for a SVN server, select 2. add-credentials.sh will prompt you for the URL of theSVN repository, for example https://svnserver/var/svn. Upon confirming, you will be promptedfor your username and password to access this SVN URL.

Note that the saved credentials are only used by Squore CLI. When you use Squore's web interface, you willneed to enter your password again to log in or browse source code.

NoteCredentials are only saved for the current user. If you want to clear the credentials saved for auser profile, remove the file $HOME/.squorerc on linux or %USERPROFILE%\.squorerc onWindows.

TipAdding credentials can be done from the command line by running the following command:

java -cp /path/to/squore-engine.jar -Dsquore.home.dir=$SQUORE_HOME com.squoring.squore.client.credentials.MakeCredentials --type squore --login demo --password demo --url http://localhost:8180/SQuORE_Server

2.4. Running The Sample ScriptsThe <INSTALLDIR>/bin folder contains scripts that use the source code in the folder <INSTALLDIR>/samples to create demo projects. You can also copy the command lines in these scripts to start creatingyour own projects.

A sample job instruction is a call to squore-engine.jar with some arguments and parameters to specifythe data providers, repository connectors and attribute values you want to use, for example:

java -Dsquore.home.dir="<SQUORE_HOME>" -jar squore-engine.jar --url="<server_url>" --login="<LOGIN>" --password="<password> --name="myProject" --wizardId="ISO9126_Java" -r "type=FROMPATH,path=/path/to/java/sources" --commands "DELEGATE_CREATION"

To learn more about command line parameters, refer to Chapter 3, Command Line Reference

2.5. Squore in a Continuous Integration EnvironmentSquore can be used in a continuous integration environment using the commands detailed in Chapter 3,Command Line Reference

Below is an example of a native call to the client using the ant exec task:

<project name="CIproject" default="build" basedir="."> <property name="squore.server" value="http://localhost:8180/SQuORE_Server> <property name="squore.client"






value="D:\CLI"/> <target name="build"> <exec executable="java"> <arg value="-Dsquore.home.dir=${SQUORE_HOME}"/> <arg value="-jar"/> <arg value="${SQUORE_HOME}\lib\squore-engine.jar"/> <arg value="--url=${squore.server.url}" /> <arg value="--version=${label}" /> <arg value="--repository type=FROMPATH,path=${source.dir}" /> <arg value="--color=rgb(255,0,0)" /> <arg value="--name=${project.name}" /> <arg value="--login=demo" /> <arg value="--password=demo" /> <arg value="--wizardId=Determine C Code Maintainability Level" /> <arg value="--tag BV=0" /> <arg value="--tag COST=0" /> <arg value="--commands=PROCESS_CREATION" /> </exec> </target></project>






3. Command Line ReferenceIn this chapter, you will learn about the commands and options you can use with squore-engine.jar

TipIn order to run a command, you always need to specify at least:

-Dsquore.home.dir=<INSTALLDIR> to tell java there Squore CLI is installed

--url=http://localhost:8180/SQuORE_Server to tell Squore CLI which Squore Server to connect to.

--login=demo to tell Squore CLI which user to connect with.

--commands="..." to tell Squore CLI what action you need it to perform.

squore.home.dir is used to set the location of Squore CLI's config.xml to${squore.home.dir}/config.xml. If your config.xml is in a different location, you canspecify it on the command line with the option: -Dsquore.configuration=/path/to/config.xml.

3.1. Squore CLI CommandsThe following is a list of commands you can use with Squore CLI and their meaning:

RETRIEVE_ENGINE_PACKAGE Retrieves the full up-to-date package of the Engine and its libraries from theserver.

SYNCHRONISE Retrieves the up-to-date configuration from the server.

GENERATE_CONF_PARAMETERS Generates the command line options associated to all parameters foundin the specified configuration file. It requires the 'projectConfFile' option to be defined.

CHECK_MODELS (since 13-A) Checks the validity of a model's configuration. It requires the'outputCheckModelsFile' option.

PROCESS_CREATION Process project creation on client-side, it is shortcut forPROCESS_TOOLS;GENERATE_TOOLS_DATA_ZIP;SEND_TOOLS_DATA.

PROCESS_TOOLS Generates data for the data providers specified in a project. It should always be calledbefore any other generation command is called.

GENERATE_TOOLS_DATA_ZIP Creates a zip archive of the data generated by the PROCESS_TOOLScommand. It should be called after the PROCESS_TOOLS command.

SEND_TOOLS_DATA Sends the zip archive generated by the GENERATE_TOOLS_DATA_ZIP command andthe project settings to the server, to request a project creation (analysis model computation and databaseupdate). It should be called after the GENERATE_TOOLS_DATA_ZIP command.

DELEGATE_CREATION Sends the project settings to the server to request a project creation.

ANALYZE_AND_DECIDE_DATA Performs the analysis model and the decision model computation on thedata generated by the PROCESS_TOOLS command. It should be called after the PROCESS_TOOLS command.

GENERATE_OUTPUT Generates output data and statistics of the project's creation. It should always becalled after all other commands.

DELETE_PROJECT --name=project_name Deletes the project project_name. This operation cannot beundone and must be called separately from any other command.

DELETE_VERSIONS --name=project_name --version=version_to_delete_from Deletes the versionsproject_name from version_to_delete_from until the latest version. This operation cannot beundone and must be called separately from any other command.

You will generally use a combination of these commands rather than a single command at a time.






If you intend to use the client as a remote control to trigger project creations on the server, use -c='DELEGATE_CREATION'.

A more common configuration is for the client to carry out the analysis and send the results to the server tocreate the project. This can be done by passing the commands -c='SYNCHRONISE;PROCESS_CREATION' .

Note: Using the SYNCHRONISE command is optional but ensures that the client and the server are using thesame model to produce analysis results.

3.2. Squore CLI ParametersParameters are used to define the environment in which commands are processed. The list of parametersis as follows:

--commands or -c (optional, default=''): The list of commands to launch. This list is a semicolon-separatedstring defining the commands to launch. Use -commands="GET_COMMANDS_LIST" to obtain the listof available commands. For more information about the available commands, refer to Section 3.1, “SquoreCLI Commands”.

--projectConfFile or -x (optional, default='null;): The XML file defining the project settings.

--url or -s (optional, default='http://localhost:8180/SQuORE_Server'): The URL of Squore Server.

--outputFile or -o (optional, default='null'): The absolute path to the output file generated by the engine.

--outputCheckModelsFile or -m (optional, default='null'):Define the absolute path to the output checkmodels file generated by the engine.

--printOutput or -print (optional, default='false'): Redirect the engine's output to the standard output.

--help or -? (optional, default='false'): Display help.

--subFoldersAsVersions or -sub (optional, default='false') (since 13-B): Loop on the repository path tocreate a version for each subfolder using the subfolder name as the version name.

--help:commands or -?cmd (optional, default='false'): Display help about the available commands.

TipWhen using a combination of a project file and some parameters passed from the command line,the command line parameters override the project file ones.

3.3. Project ParametersIn order to create a project, you need to pass project parameters to Squore CLI. The following is a list of theparameters and their meaning:

--name or -n=MyProject defines the name of the project that will be created

--group=MyGroup (since 14-A) defines the group that the project belongs to. Projects from the same groupare displayed together in the project portfolios and the group can optionally be rated as a whole. Notethat you can specify subgroups by adding a / in your group name: --group="prototype/phase1" will createa phase1 group under a prototype group.

--color=rgb(130,196,240) defines the color used to identify the project in the Squore user interface afterits creation. The numbers define the numbers define the values for red, green and blue respectively. Notethat if you do not specify a colour on the command line, a random colour will be picked.

--autoBaseline or -b=true instructs Squore CLI to build a baseline version that will not be overwritten bya subsequent analysis. When set to false, every analysis overwrites the previous one, until a new baselineis created. If not set, this parameter defaults to true.






--KeepDataFiles=true|false instructs Squore to keep or discard analysis files from old versions or only forthe latest baseline. Note that this behaviour only affects disk space on the server, not the analysis results.--version or -v=v1 defines the label used for the version of this project.--versionDate="YYYY-MM-DDTHH:MM:SS" (default: actual analysis time) allows specifying a date for theversion that is different from the current date. This is useful when the charts on your dashbaord haves axesor intervalls that show dates instead of version names. Note that for evey new analysis, the date must beafter the date of the previous analysis.--login or u=demo is the ID of the user requesting the project creation.--password -k=demo is the password of the user requesting the project creation. If you do not want tospeficy a password in your command line, refer to Section 2.3, “Saving Credentials to Disk”.--teamUser or q="mike,DEVELOPER;john,TESTER;peter,PROJECT_MANAGER" is a semicolon-separatedlist of login,roleID pairs used to define a list of users who will be able to access the project when itis created.Note that this option is taken into account when creating a new project but is ignored when creating a newversion. In order to edit the list of users in a project team, you must use the Squore web interface.

Refer to the list of available roleIDs in Squore by clicking Administration > Roles. This option can becombined with the teamGroup parameter if needed.--teamGroup or g="devUsers,DEVELOPER;management,GUEST" is a semicolon-separated list ofgroup,roleID pairs used to define a list of groups who will be able to access the project when it iscreated.Note that this option is taken into account when creating a new project but is ignored when creating a newversion. In order to edit the list of groups in a project team, you must use the Squore web interface.

Refer to the list of available roleIDs in Squore by clicking Administration > Roles. This option can becombined with the teamUser parameter if needed.--WizardId or -w=ISO9126_C The id of the wizard used to create the project. If this parameter is notspecified, it will be read from the wizard settings.--versionPattern=V#.N# defines the pattern used to label the version automatically if no version parameterwas passed.--tag or -t TAGNAME="tagValue" If the wizard allows tags (i.e. project attributes), then use the thisparameter to inform the CLI of the tag values to use for this project.--repository or -r "type=REPOTYPE,opt1=value1,opt2=value2" is how you specify repository for sources.For more information about repositories syntax, refer to Chapter 4, Repository Connectors.--dp or -d "type=DPName,dp_opt=dp_opt_value" is how you specify information for data providers. Formore information about individual data provider syntax, refer to Chapter 5, Data Providers.--filter or -f "FILTER_OPTS" is a semicolon-separated string of triplets {artefactType,filterType,filterValue}.In order to export the measure LC at application level and the indicator MAIN at application level, pass -f"APPLICATION,MEASURE,LC;APPLICATION,INDICATOR_LEVEL,MAIN;".

The artefact type ALL_TYPES and the filter types ALL_DEFECT_REPORTS, ALL_MEASURES,ALL_INDICATORS_LEVELS and ALL_INDICATORS_RANKS can also be used, followed by an empty filtervalue. In order to export all measures at application level in the output file, pass the parameter --filter="APPLICATION,ALL_MEASURES,;". In order to export all indicators for all artefact types in the outputfile, pass the parameter --filter="ALL_TYPES,ALL_INDICATORS_LEVELS,;".

WarningThe --language and --extensions parameters are deprecated (since 14-B), since they are nowparameters of the SQuORE data provider. Where you previously specified:

--language java --extensions .java






You now need to specify:

--dp "type=SQuORE,languages=java:.java;"

Using --language=auto is also no longer supported, all languages present in the project musi bespecified, along with their expected extensions (without duplication in the list of extensions. In orderto analyse sources containing PHP and Javascript code for example, you now need to use:

--dp "type=SQuORE,languages=php:.php;javascript:.js,.JS"

The rest of the parameters that you will pass to the Engine to create projects are specific to repositoryconnectors and data providers and are detailed respectively in the Chapter 4, Repository Connectors andChapter 5, Data Providers.

TipThe versionPattern parameter allows specifying a pattern to create the version name automaticallyfor every analysis. It supports the following syntax:

#N#: A number that is automatically incremented

#Nn#: A number that is automatically incremented using n digits

#Y2#: The current year in 2-digit format

#Y4#: The current year in 4-digit format

#M#: The current month in two digit format

#D#: The current day in two digit format

#H#: The current hour in 24 hour format

#MN#: The current minute in two digit format

#S#: The current second in two digit format

Any character other than # is allowed in the pattern. As an example, if you want to produce versionslabelled build-198.2013-07-28_13h07m (where 198 is an auto-incremented number andthe date and time are the timestamp of the project creation), you would use the pattern: build-#N3#.#Y4#-#M#-#D#_#H#h#MN#m

3.4. Exit CodesAfter a successful or unsuccessful run, the CLI returns an exit code from this list:

0: OK - The operation completed successfully.

1: Client creation error - There was an error launching the client process.

2: Configuration error - This could be due to an unreachable configuration file or a parameter set to aninvalid value.

3: Problem while launching one of the commands - One of the commands failed to complete successfully.The console should provide information about what exactly failed.

4: Engine validity error - The client you are running is not compatible with the server. You should try to runthe command RETRIEVE_ENGINE_PACKAGE to get the latest compatible package from the server.






4. Repository Connectors4.1. Folder Path

You can analyse sources from a local or mapped share by using the following parameters:

path=[text] the absolute path to the folder containing the sources to analyse

The full parameter to be used with Squore CLI is:

-r "type=FROMPATH,path=..."

4.2. Zip FileYou can analyse sources contained in a zip file by using the following parameters:

path=[text] the absolute path to the zip file containing the sources to analyse on Squore Server.

The full parameter to be used with Squore CLI is:

-r "type=FROMZIP,path=..."

Note: It is only possible to analyse a zip file that is accessible to Squore Server. The CLI does not supportuploading a zip file to the Server.

4.3. ClearCaseYou can pull sources from a ClearCase repository by using the following parameters:

view_root_path=[text] View root path (default value: '/view')

vob_root_path=[text] Vob root path (default value: '/projets')

view=[text] View (default value: '')

server_display_view=[text] Server Display View (optional) (default value: '')

sub_path=[text] Sources Path (excluding view and vobs) (default value: '')

The full command line syntax for ClearCase is:

-r "type=ClearCase,view_root_path=/view,vob_root_path=/projets,view=,server_display_view=,sub_path="

Note that the ClearCase tool is configured for Linux only.

It is possible to make it work for Windows by editing the configuration file clearcase_conf.tcl in<INSTALLDIR>/Configuration/repositoryConnectors and modifying the path to cleartool.exe according to yourinstallation.

Also, note that the sub_path parameter is only necessary if you want to restrict to a directory lower than root.

The command executed on the server to check out source code is: $cleartool $view_root_path $view$vob_root_path.

4.4. CVSYou can pull sources from a CVS repository by using the following parameters:






repository=[text] Repository (default value: '')

project=[text] Project (default value: '')

branch=[text] Tag or Branch (optional) (default value: '')

The full command line syntax for CVS is:

-r "type=CVS,repository=,project=,branch="

4.5. GitYou can pull sources from a Git repository by using the following parameters:

url=[text] Url (default value: '')

commit=[text] Branch or commit (optional) (default value: '')

subDir=[text] Subdirectory (optional) (default value: '')

The full command line syntax for Git is:

-r "type=Git,url=,commit=,subDir="

4.6. MKSYou can pull sources from a MKS repository by using the following parameters:

hostname=[text] Server Hostname (default value: '')

port=[text] Server Port (default value: '')

project=[text] Project (default value: '')

revision=[text] Revision (default value: '')

useAccountCredentials=[multipleChoice] (default value: 'NO_CREDENTIALS')

username=[text] Username (default value: '')

password=[password] Password (default value: '')

The full command line syntax for MKS is:

-r "type=MKS,hostname=,port=,project=,revision=,useAccountCredentials=NO_CREDENTIALS,username=,password="

MKS Source Integrity repository connector

4.7. PerforceYou can pull sources from a Perforce repository by using the following parameters:

p4port=[text] P4PORT ([protocol]hostport) (default value: '')

depot=[text] Depot (and optionnally subforders) (default value: '')

label=[text] label, changelist or date (optional) (default value: '')









The full command line syntax for Perforce is:

-r "type=Perforce,p4port=,depot=,label=,useAccountCredentials=NO_CREDENTIALS,username=,password="

The Perforce repository connector assumes that the specified depot exists on the specified Perforce server,that Squore can access this depot and that the Perforce user defined has the right to access it.

The host where the analysis takes place must have a Perforce command-line client (p4) installed and fullyfunctional.

The P4PORT environment variable is not read by Squore. You have to set it in the form. The path to the p4command can be configured in the perforce_conf.tcl file located in the configuration/repositoryConnectors/Perforce folder.

4.8. SVNYou can pull sources from a SVN repository by using the following parameters:

url=[text] Url (default value: '')

rev=[text] Revision (optional) (default value: '')




The full command line syntax for SVN is:

-r "type=SVN,url=,rev=,useAccountCredentials=NO_CREDENTIALS,username=,password="

Connecting to an SVN server is supported using svn over ssh, or by using a username andpassword. If no authentication is needed, use useAccountCredentials=NO_CREDENTIALS, otherwise useuseAccountCredentials=PERSONAL_CREDENTIALS and fill in the username and password fields.

The command run by the server to extract the source code is svn export --force --non-interactive $url.

4.9. SynergyYou can pull sources from a Synergy repository by using the following parameters:

server=[text] Server URL (if distant) (default value: '')

db=[text] Database path (default value: '')

projectSpec=[text] Project specification (default value: '')

subFolder=[text] Subfolder (optional) (default value: '')


name=[text] User (default value: '')


The full command line syntax for Synergy is:

-r "type=Synergy,server=,db=,projectSpec=,subFolder=,useAccountCredentials=NO_CREDENTIALS,name=,password="

The Synergy repository connector assumes that a project already exists and that the Synergy user definedhas the right to access it.






The host where the analysis takes place must have Synergy installed and fully functional. Note that,as stated in IBM's documentation on http://pic.dhe.ibm.com/infocenter/synhelp/v7m2r0/index.jsp?topic=%2Fcom.ibm.rational.synergy.manage.doc%2Ftopics%2Fsc_t_h_start_cli_session.html, using credentials isonly supported on Windows, so use the NO_CREDENTIALS option when Synergy runs on a Linux host.

4.10. TFSYou can pull sources from a TFS repository by using the following parameters:

URL=[text] Server URL (default value: '')

path=[text] Project Path (default value: '')

version=[text] Version (optional) (default value: '')




The full command line syntax for TFS is:

-r "type=TFS,URL=,path=,version=,useAccountCredentials=NO_CREDENTIALS,username=,password="

The TFS repository connector (Team Foundation Server - Team Foundation Version Control) assumes that aTFS command-line client (Visual Studio Client or Team Explorer Everywhere) is installed on the Squore serverand fully functional.

The configuration of this client must be set up in the tfs_conf.tcl file.

The repository connector form must be filled according to the TFS standard (eg. the Project Path must beginwith the '$' character...). Note that this repository connector works with a temporary workspace that isdeleted at the end of the analysis.

4.11. Using Multiple NodesSquore allows using multiple repositories in the same analysis. If your project consists of some code that isspread over two distinct servers or SVN repositories, you can set up your project so that it includes bothlocations in the project analysis. This is done by labelling each source code node before specifying parameters,as shown below

-r "type=FROMPATH,alias=Node1,path=/home/projects/client-code"-r "type=FROMPATH,alias=Node2,path=/home/projects/common/lib"

Note that only alpha-numeric characters are allowed to be used as labels. In the artefact tree, each node willappear as a separate top-level folder with the label provided at project creation.

Using multiple nodes, you can also analyse sources using different repository connectors in the same analysis:

-r "type=FROMPATH,alias=Node1,path=/home/projects/common-config"-r "type=SVN,alias=Node2,url=svn+ssh://10.10.0.1/var/svn/project/src,rev=HEAD"

4.12. Using Data Provider Input Files From Version ControlInput files for Squore's data providers, like source code, can be located in your version control system. Whenthis is the case, you need to specify a variable in the input field for the data provider instead of an absolutepath to the input file.

http://pic.dhe.ibm.com/infocenter/synhelp/v7m2r0/index.jsp?topic=%2Fcom.ibm.rational.synergy.manage.doc%2Ftopics%2Fsc_t_h_start_cli_session.html

http://pic.dhe.ibm.com/infocenter/synhelp/v7m2r0/index.jsp?topic=%2Fcom.ibm.rational.synergy.manage.doc%2Ftopics%2Fsc_t_h_start_cli_session.html






A data provider using an input file extracted from a remote repository

The variable to use varies depending on your scenario:

You have only one node of source code in your projectIn this case, the variable to use is $src.

You have more than one node of source code in your projectIn this case, you need to tell Squore in which node the input file is located. This is done using a variable thathas the same name as the alias you defined for the source code node in the previous step of the wizard. Forexample, if your nodes are labelled Node1 and Node2 (the default names), then you can refer to themusing the $Node1 and $Node2 variables.

TipWhen using these variables from the command line on a linux system, the $ symbol must be escaped:

-d "type=PMD,configFile=\$src/pmd_data.xml"






5. Data ProvidersThis chapter describe the data providers shipped with Squore and the default parameters that they acceptvia the Command Line Interface.

5.1. AntiC

5.1.1. DescriptionAntiC is a part of the jlint static analysis suite that Squore launches to analyse C and C++ source code. Notethat on Linux, the antiC executable must be compiled manually before you run it for the first time by runningthe command:

# cd <INSTALLDIR>/addons/Antic_auto/bin/ && gcc antic.c -o antic

For more details, refer to the AntiC website: http://jlint.sourceforge.net/

5.1.2. MeasuresSquore imports the following measures when running AntiC:

AntiC results are imported by Squore and produce findings on C and C++ code.

5.1.3. UsageAntiC has the following options:

dir=[text]: Source code directory to analyse (leave empty to analyse all sources)

The full command line syntax for AntiC is:

-d "type=Antic_auto,dir=[text]"

5.2. Bullseye Code Coverage

5.2.1. DescriptionBullseyeCoverage is a code coverage analyzer for C++ and C. Squore uses the coverage report file to generatemetrics.

For more details, refer to the Bullseye Code Coverage website: http://www.bullseye.com/

5.2.2. MeasuresSquore imports the following measures when running Bullseye Code Coverage:

Squore creates several measures based on the results from the report file.

5.2.3. UsageBullseye Code Coverage has the following options:

html=[text]: Path of the Bullseye coverage Html report file

http://jlint.sourceforge.net/

http://www.bullseye.com/






The full command line syntax for Bullseye Code Coverage is:

-d "type=BullseyeCoverage,html=[text]"

5.3. CPD

5.3.1. DescriptionCPD is an open source tool which generates Copy/Paste metrics. The dectection of duplicated blocks is set to100 tokens. CPD provides an xml file which can be imported into Squore.

For more details, refer to the CPD website: http://pmd.sourceforge.net/cpd.html

5.3.2. MeasuresSquore imports the following measures when running CPD:

DLN: Duplicated Line of code (The number of lines in the file which are duplicated somewhere in the sourcecode)

5.3.3. UsageCPD has the following options:

xml=[text]: XML file containing PMD/CPD results

The full command line syntax for CPD is:

-d "type=CPD,xml=[text]"

5.4. CPD (plugin)

5.4.1. DescriptionCPD is an open source tool which generates Copy/Paste metrics. The dectection of duplicated blocks isset to 100 tokens. When using this data provider, Squore launches the CPD analyser and imports theresults generated. Note that the data provider requires an extra download to extract the CPD binaryin <INSTALLDIR>/addons/tools/CPD_auto/. For more information, refer to the Installation andAdministration Guide's "Third-Party Plugins and Applications" section.

For more details, refer to the CPD (plugin) website: http://pmd.sourceforge.net/cpd.html

5.4.2. MeasuresSquore imports the following measures when running CPD (plugin):

DLN: Duplicated Line of code (The number of lines in the file which are duplicated somewhere in the sourcecode)

5.4.3. UsageCPD (plugin) has the following options:

http://pmd.sourceforge.net/cpd.html

http://pmd.sourceforge.net/cpd.html






cpd_auto=[booleanChoice]: Execute CPD?

The full command line syntax for CPD (plugin) is:

-d "type=CPD_auto,cpd_auto=[booleanChoice]"

5.5. CPPCheck

5.5.1. DescriptionCppcheck is a static analysis tools for C++ applications. The tools provides an xml output which can be importedinto Squore.

For more details, refer to the CPPCheck website: http://sourceforge.net/apps/mediawiki/cppcheck/index.php?title=Main_Page

5.5.2. MeasuresSquore imports the following measures when running CPPCheck:

Information from CPPCheck is turned into findings in Squore as we can locate each violation/issue at aprecise line of code. Findings can be: Bounds checking, Memory leaks, Null pointer...

5.5.3. UsageCPPCheck has the following options:

xml=[text]: XML file containing CPPCheck results

The full command line syntax for CPPCheck is:

-d "type=CPPCheck,xml=[text]"

5.6. CPPCheck (plugin)

5.6.1. DescriptionThe CPPCheck_auto data provider launches Cppcheck to analyse the source code in your project. Note that onWindows, this data provider requires an extra download to extract the Cppcheck binary in <INSTALLDIR>/addons/tools/CPPCheck_auto/. On Linux, you can install the cppcheck application anywhere youwant as long as the cppcheck command is available from the command line. For more information, refer tothe Installation and Administration Guide's "Third-Party Plugins and Applications" section.

For more details, refer to the CPPCheck (plugin) website: http://sourceforge.net/apps/mediawiki/cppcheck/index.php?title=Main_Page

5.6.2. MeasuresSquore imports the following measures when running CPPCheck (plugin):

Information from Cppcheck is turned into findings in Squore as we can locate each violation/issue at aprecise line of code. Findings can be: Bounds checking, Memory leaks, Null pointer...

http://sourceforge.net/apps/mediawiki/cppcheck/index.php?title=Main_Page









5.6.3. UsageCPPCheck (plugin) has the following options:

dir=[text]: Source code directory to analyse (leave empty to analyse all sources)

The full command line syntax for CPPCheck (plugin) is:

-d "type=CPPCheck_auto,dir=[text]"

5.7. CPPTest

5.7.1. DescriptionParasoft C/C++test is an integrated solution for automating a broad range of best practices proven to improvesoftware development team productivity and software quality for C and C++. The tools provides an xml outputwhich can be imported into Squore.

For more details, refer to the CPPTest website: http://www.parasoft.com/jsp/products/cpptest.jsp?itemId=47

5.7.2. MeasuresSquore imports the following measures when running CPPTest:

Information from Parasoft C/C++test is imported as finding: each violation is assigned to line. You will findmore information on metrix/findings of Parasoft C++Test on their website.

5.7.3. UsageCPPTest has the following options:

xml=[text]: XML file containing CPPTest data

The full command line syntax for CPPTest is:

-d "type=CPPTest,xml=[text]"

5.8. CheckStyle

5.8.1. DescriptionCheckStyle is an open source tool that verifies that Java applications adhere to certain coding standards. Itproduces an xml file which can be imported into Squore.

For more details, refer to the CheckStyle website: http://checkstyle.sourceforge.net/

5.8.2. MeasuresSquore imports the following measures when running CheckStyle:

CheckStyle results are imported as findings into Squore. Each violation can be associated to a specific line.The list of available findings can be found here: http://checkstyle.sourceforge.net/availablechecks.html

http://www.parasoft.com/jsp/products/cpptest.jsp?itemId=47

http://www.parasoft.com/jsp/products/cpptest.jsp?itemId=47

http://checkstyle.sourceforge.net/

http://checkstyle.sourceforge.net/availablechecks.html






5.8.3. UsageCheckStyle has the following options:

xml=[text]: CheckStyle results file containging rule violations

The full command line syntax for CheckStyle is:

-d "type=CheckStyle,xml=[text]"

5.9. CheckStyle (plugin)

5.9.1. DescriptionCheckStyle is an open source tool that verifies that Java applications adhere to certain coding standards. Thisdata provider triggers the execution of Checkstyle for the current Squore project and automatically integratesthe Checkstyle results as findings. Note that the data provider requires an extra download to extract theCheckStyle binary in <INSTALLDIR>/addons/tools/CheckStyle_auto/. For more information,refer to the Installation and Administration Guide's "Third-Party Plugins and Applications" section.

For more details, refer to the CheckStyle (plugin) website: http://checkstyle.sourceforge.net/

5.9.2. MeasuresSquore imports the following measures when running CheckStyle (plugin):

CheckStyle results are imported as findings into Squore. Each violation can be associated to a specific line.The list of findings can be found here: http://checkstyle.sourceforge.net/availablechecks.html

5.9.3. UsageCheckStyle (plugin) has the following options:

configFile=[text]: CheckStyle configuration file

xmx=[text]: Memory allocated to Xmx when launching CheckStyle

The full command line syntax for CheckStyle (plugin) is:

-d "type=CheckStyle_auto,configFile=[text],xmx=[text]"

5.10. CheckStyle for SQALE (plugin)

5.10.1. DescriptionCheckStyle is an open source tool that verifies that Java applications adhere to certain coding standards.This data provider triggers the execution of Checkstyle for the current Squore project and automaticallyintegrates the Checkstyle results as findings. Note that the data provider requires an extra download to extractthe CheckStyle binary in <INSTALLDIR>/addons/tools/CheckStyle_auto_for_SQALE/. Formore information, refer to the Installation and Administration Guide's "Third-Party Plugins and Applications"section.

For more details, refer to the CheckStyle for SQALE (plugin) website: http://checkstyle.sourceforge.net/









5.10.2. MeasuresSquore imports the following measures when running CheckStyle for SQALE (plugin):

CheckStyle results are imported as findings into Squore. Each violation can be associated to a specific line.The list of findings can be found here: http://checkstyle.sourceforge.net/availablechecks.html

5.10.3. UsageCheckStyle for SQALE (plugin) has the following options:

configFile=[text]: CheckStyle configuration file

xmx=[text]: Memory allocated to Xmx when launching CheckStyle

The full command line syntax for CheckStyle for SQALE (plugin) is:

-d "type=CheckStyle_auto_for_SQALE,configFile=[text],xmx=[text]"

5.11. CodeSonar

5.11.1. DescriptionCodesonar is a static analysis tool for C and C++ code designed for zero tolerance defect environments. Itprovides an xml output file which is imported into Squore.

For more details, refer to the CodeSonar website: http://www.grammatech.com/products/codesonar/overview.html

5.11.2. MeasuresSquore imports the following measures when running CodeSonar:

Information from Codesonar is turned into findings in Squore as we can locate each violation/issue at aprecise line of code. Verification of Codesonar includes (non exhaustive list): Data Race Condition, Shareddata accessed in an unsafe manner., Deadlock, Two or more threads prevent each other from makingprogress., Process Starvation, A thread of execution may not run., Buffer Overrun (example), A read orwrite to data after the end of a buffer., Leak (example), Dynamically allocated storage has not been freed.,Null Pointer Dereference (example), An attempt to dereference a pointer to the address 0., Type Overrun,An overrun of a boundary within an aggregate type., Type Underrun, An underrun of a boundary withinan aggregate type., Divide By Zero, An attempt to perform integer division where the denominator is0., Double Free, Two calls to free on the same object., Use After Free, A dereference of a pointer toa freed object., Free Non-Heap Variable, An attempt to free an object which was not allocated on theheap, such as a stack-allocated variable., Uninitialized Variable, An attempt to use the value of a variablethat has not been initialized., Dangerous Function Cast, A function pointer is cast to another functionpointer having an incompatible signature or return type., Delete[] Object Created by malloc, An attemptto release memory obtained with malloc using delete[], Delete[] Object Created by new, An attempt torelease memory obtained with new using delete[], Delete Object Created by malloc, An attempt to releasememory obtained with malloc using delete, Delete Object Created by new[], An attempt to release memoryobtained with new[] using delete, Free Object Created by new[], An attempt to release memory obtainedwith new[] using free, Free Object Created by new, An attempt to release memory obtained with newusing free, Missing Return Statement, At least one path through a non-void return-type function does notcontain a return statement., Redundant Condition, Some condition is either always or never satisfied.,Return Pointer To Local, A procedure returns a pointer to one of its local variables., Return Pointer To


http://www.grammatech.com/products/codesonar/overview.html

http://www.grammatech.com/products/codesonar/overview.html






Freed, A procedure returns a pointer to memory that has already been freed., Unused Value, A variable isassigned a value, but that value is never subsequently used on any execution path., Useless Assignment,Some assignment always assigns the value that the variable being modified already has., Varargs FunctionCast, A varargs function pointer is cast to another function pointer having different parameters or returntype., Ignored Return Value, The value returned by some function has not been used., Free Null Pointer,An attempt to free a null pointer., Unreachable Code, Some of the code in a function is unreachable fromthe function entry point under any circumstances., Null Test After Dereference, A pointer is NULL-checkedwhen it has already been dereferenced., Format String, A function that should have a format string passedin a particular argument position has been passed a string that either is not a format string or is from anuntrusted source. (Potential security vulnerability.), Double Close, An attempt to close a file descriptor orfile pointer twice., TOCTTOU Vulnerability, A time-of-check-to-time-of-use race condition that can create asecurity vulnerability., Double Lock, An attempt to lock a mutex twice., Double Unlock, An attempt to unlocka mutex twice., Try-lock that will never succeed, An attempt to lock a mutex that cannot possibly succeed.,Misuse of Memory Allocation, Incorrect use of memory allocators., Misuse of Memory Copying, Incorrectuse of copying functions., Misuse of Libraries, Misuse of standard library functions., User-Defined BugClasses, Checks for arbitrary bug classes can be implemented through the CodeSonar extension functions...

5.11.3. UsageCodeSonar has the following options:

xml=[text]: XML file containing CodeSonar results

The full command line syntax for CodeSonar is:

-d "type=CodeSonar,xml=[text]"

5.12. Coverity

5.12.1. DescriptionCoverity is a static analysis tool for C, C++, Java and C#. It provides an xml output which can be importedinto Squore.

For more details, refer to the Coverity website: http://www.coverity.com/

5.12.2. MeasuresSquore imports the following measures when running Coverity:

Information from Coverity is turned into findings in Squore as we can locate each violation/issue at a preciseline of code. Findings can be: division by Zero, null pointer use, memory leaks...

5.12.3. UsageCoverity has the following options:

xml=[text]: XML file containing Coverity results

The full command line syntax for Coverity is:

-d "type=Coverity,xml=[text]"

http://www.coverity.com/






5.13. FindBugs

5.13.1. DescriptionFindbugs is an open source tool toat looks for bugs in Java code. It produces an xml result file which can beimported into Squore.

For more details, refer to the FindBugs website: http://findbugs.sourceforge.net/

5.13.2. MeasuresSquore imports the following measures when running FindBugs:

Information from Findbugs results files is imported as findings into Squore. Each violation can beassociated to a specific line. The list of findings can be found here: http://findbugs.sourceforge.net/bugDescriptions.html

5.13.3. UsageFindBugs has the following options:

xml=[text]: XML file containing FindBugs results

The full command line syntax for FindBugs is:

-d "type=Findbugs,xml=[text]"

5.14. FindBugs (plugin)

5.14.1. DescriptionFindbugs is an open source tool toat looks for bugs in Java code. When using this data provider, Squorelaunches an Findbugs analysis on the specified directory and imports the results generated. Note that the dataprovider requires an extra download to extract the Findbugs binary in <INSTALLDIR>/addons/tools/Findbugs_auto/. For more information, refer to the Installation and Administration Guide's "Third-PartyPlugins and Applications" section.

For more details, refer to the FindBugs (plugin) website: http://findbugs.sourceforge.net/

5.14.2. MeasuresSquore imports the following measures when running FindBugs (plugin):

Information from Findbugs results files is imported as findings into Squore. Each violation can beassociated to a specific line. The list of findings can be found here: http://findbugs.sourceforge.net/bugDescriptions.html

5.14.3. UsageFindBugs (plugin) has the following options:

class_dir=[text]: Directory containing the .class or .jar filesxmx=[text]: Memory allocated to Xmx when launching Findbugs

http://findbugs.sourceforge.net/

http://findbugs.sourceforge.net/bugDescriptions.html


http://findbugs.sourceforge.net/








The full command line syntax for FindBugs (plugin) is:

-d "type=Findbugs_auto,class_dir=[text],xmx=[text]"

5.15. FxCop

5.15.1. DescriptionFxCop is an application that analyzes managed code assemblies (code that targets the .NET Frameworkcommon language runtime) and reports information about the assemblies, such as possible design,localization, performance, and security improvements. Fxcop generates an XML results file which can beimported into Squore.

For more details, refer to the FxCop website: http://msdn.microsoft.com/en-us/library/bb429476(v=vs.80).aspx

5.15.2. MeasuresSquore imports the following measures when running FxCop:

Information from Fxcop is imported as findings into Squore. Each violation can be associated toa specific line. The list of findings can be found here: http://msdn.microsoft.com/en-US/library/bb429379(v=vs.80).aspx

5.15.3. UsageFxCop has the following options:

xml=[text]: XML file containing FxCop analysis data

The full command line syntax for FxCop is:

-d "type=FxCop,xml=[text]"

5.16. GCov

5.16.1. DescriptionGCov is a Code coverage program for C application. GCov generates an XML results file which can be importedinto Squore.

For more details, refer to the GCov website: http://gcc.gnu.org/onlinedocs/gcc/Gcov.html

5.16.2. MeasuresSquore imports the following measures when running GCov:

COV: Code coverage at function, file and application level.

5.16.3. UsageGCov has the following options:

http://msdn.microsoft.com/en-us/library/bb429476(v=vs.80).aspx

http://msdn.microsoft.com/en-us/library/bb429476(v=vs.80).aspx

http://msdn.microsoft.com/en-US/library/bb429379(v=vs.80).aspx

http://msdn.microsoft.com/en-US/library/bb429379(v=vs.80).aspx

http://gcc.gnu.org/onlinedocs/gcc/Gcov.html






xml=[text]: XML file containing GCov results

The full command line syntax for GCov is:

-d "type=GCov,xml=[text]"

5.17. GnatCheck

5.17.1. DescriptionGNATcheck is an extensible rule-based tool with an easy-to-use interface. It allows developers to completelydefine a coding standard

For more details, refer to the GnatCheck website: https://www.adacore.com/gnatpro/toolsuite/gnatcheck/

5.17.2. MeasuresSquore imports the following measures when running GnatCheck:

Several finding attached to artefacts.

5.17.3. UsageGnatCheck has the following options:

txt=[text]: XML file containing GnatCheck results

The full command line syntax for GnatCheck is:

-d "type=GnatCheck,txt=[text]"

5.18. GnatCompiler

5.18.1. DescriptionGNAT is a free-software compiler for the Ada programming language which forms part of the GNU CompilerCollection. It supports all versions of the language, i.e. Ada 2012, Ada 2005, Ada 95 and Ada 83. Originally itsname was an acronym that stood for GNU NYU Ada Translator, but that name no longer applies. The front-end and run-time are written in Ada.

For more details, refer to the GnatCompiler website: http://www.adacore.com/

5.18.2. MeasuresSquore imports the following measures when running GnatCompiler:


5.18.3. UsageGnatCompiler has the following options:

log=[text]: Log file containing compiler warnings

https://www.adacore.com/gnatpro/toolsuite/gnatcheck/

http://www.adacore.com/






The full command line syntax for GnatCompiler is:

-d "type=GnatCompiler,log=[text]"

5.19. JUnit

5.19.1. DescriptionJUnit is a simple framework to write repeatable tests. It is an instance of the xUnit architecture for unit testingframeworks.

For more details, refer to the JUnit website: http://junit.org/

5.19.2. MeasuresSquore imports the following measures when running JUnit:

JUnit XML result files are imported into Squore as findings and the total number of tests is made availabelas a measure.

5.19.3. UsageJUnit has the following options:

resultDir=[text]: Directory containing JUnit xml result files

The full command line syntax for JUnit is:

-d "type=JUnit,resultDir=[text]"

5.20. Jacoco

5.20.1. DescriptionJaCoCo is a free code coverage library for Java, which has been created by the EclEmma team based on thelessons learned from using and integration existing libraries for many years.

For more details, refer to the Jacoco website: http://www.eclemma.org/jacoco/

5.20.2. MeasuresSquore imports the following measures when running Jacoco:

The coverage information from the Jacoco results file is imported as a base measure for functions andclasses.

5.20.3. UsageJacoco has the following options:

xml=[text]: XML file containing Jacoco results

The full command line syntax for Jacoco is:

http://junit.org/

http://www.eclemma.org/jacoco/






-d "type=Jacoco,xml=[text]"

5.21. Klocwork

5.21.1. DescriptionKlocwork is a static analysis tool. It produces an xml output which can be imported into Squore.

For more details, refer to the Klocwork website: http://www.klocwork.com

5.21.2. MeasuresSquore imports the following measures when running Klocwork:

Information from Klocwork is turned into findings in Squore as we can locate each violation/issue at aprecise line of code. Findings can be: division by Zero, null pointer use, memory leaks...

5.21.3. UsageKlocwork has the following options:

xml=[text]: XML file containing Klocwork results

The full command line syntax for Klocwork is:

-d "type=Klocwork,xml=[text]"

5.22. NCover

5.22.1. DescriptionNCover is a Code coverage program for C# application. NCover generates an XML results file which can beimported into Squore.

For more details, refer to the NCover website: http://www.ncover.com/

5.22.2. MeasuresSquore imports the following measures when running NCover:

COV: Code coverage at function, class, file and application level.

5.22.3. UsageNCover has the following options:

xml=[text]: XML file containing NCover results

The full command line syntax for NCover is:

-d "type=NCover,xml=[text]"

http://www.klocwork.com

http://www.ncover.com/






5.23. Oracle PLSQL compiler Warning checker

5.23.1. DescriptionThis data provider reads an Oracls compiler log file and imports them as Squore findings.

For more details, refer to the Oracle PLSQL compiler Warning checker website: http://www.oracle.com/index.html

5.23.2. MeasuresSquore imports the following measures when running Oracle PLSQL compiler Warning checker:


5.23.3. UsageOracle PLSQL compiler Warning checker has the following options:

log=[text]: Compiler log file

prefix=[text]: Prefixes used as filters, and their replacement (empty=don't filter)

The full command line syntax for Oracle PLSQL compiler Warning checker is:

-d "type=Oracle_PLSQLCompiler,log=[text],prefix=[text]"

5.24. MISRA Rule Checking using PC Lint

5.24.1. DescriptionPCLint is a static code analyser. The PCLint data provider reads an PCLint log file and imports MISRA violationsas Squore findings.

For more details, refer to the MISRA Rule Checking using PC Lint website: http://www.gimpel.com/html/pcl.htm

5.24.2. MeasuresSquore imports the following measures when running MISRA Rule Checking using PC Lint:


5.24.3. UsageMISRA Rule Checking using PC Lint has the following options:

logDir=[text]: Path of the directory containing PC_lint log files

excludedExtensions=[text]: File extensions to exclude from the reported violations

The full command line syntax for MISRA Rule Checking using PC Lint is:

-d "type=PC_Lint_MISRA,logDir=[text],excludedExtensions=[text]"

http://www.oracle.com/index.html

http://www.oracle.com/index.html

http://www.gimpel.com/html/pcl.htm

http://www.gimpel.com/html/pcl.htm






5.25. PMD

5.25.1. DescriptionPMD scans Java source code and looks for potential problems like possible bugs, dead code, sub-optimal code,overcomplicated expressions, duplicate code ... The XML results file it generates is read by Squore to createfindings.

For more details, refer to the PMD website: http://pmd.sourceforge.net

5.25.2. MeasuresSquore imports the following measures when running PMD:

Squore imports the findings from the XML file and maps them to artefacts

5.25.3. UsagePMD has the following options:

xml=[text]: XML file containing PMD results

The full command line syntax for PMD is:

-d "type=PMD,xml=[text]"

5.26. PMD (plugin)

5.26.1. DescriptionPMD scans Java source code and looks for potential problems like possible bugs, dead code, sub-optimalcode, overcomplicated expressions, duplicate code ... When using this data provider, Squore launches PMDto analyse the source code and the XML results file it generates is read by Squore to create findings. Notethat the data provider requires an extra download to extract the PMD binary in <INSTALLDIR>/addons/tools/PMD_auto/. For more information, refer to the Installation and Administration Guide's "Third-PartyPlugins and Applications" section.

For more details, refer to the PMD (plugin) website: http://pmd.sourceforge.net

5.26.2. MeasuresSquore imports the following measures when running PMD (plugin):

Squore imports the findings from the XML file and maps them to artefacts

5.26.3. UsagePMD (plugin) has the following options:

configFile=[text]: Rule set file

The full command line syntax for PMD (plugin) is:

-d "type=PMD_auto,configFile=[text]"

http://pmd.sourceforge.net

http://pmd.sourceforge.net






5.27. Polyspace

5.27.1. DescriptionPolyspace is a static analysis tool which includes a MISRA checker. It produces an xml output which can beimported into Squore.

For more details, refer to the Polyspace website: http://www.mathworks.fr/products/polyspace/

5.27.2. MeasuresSquore imports the following measures when running Polyspace:

Polyspace Verifier detects RTE (RunTime Error) such as Division by zero, Illegal Deferencement Pointer,Out of bound array index... Such information is turned into statistical measures at function level. Numberof Red (justified/non-justified), Number of Grey (justified/non-justified), Number of Orange (justified/non-justified), Number of Green

5.27.3. UsagePolyspace has the following options:

xml=[text]: XML file containing Polyspace results

The full command line syntax for Polyspace is:

-d "type=Polyspace,xml=[text]"

5.28. MISRA Rule Checking using Polyspace

5.28.1. DescriptionPolyspace is a static analysis tool which include a MISRA checker. The tools provides an xml output which canbe imported into Squore.

For more details, refer to the MISRA Rule Checking using Polyspace website: http://www.mathworks.fr/products/polyspace/

5.28.2. MeasuresSquore imports the following measures when running MISRA Rule Checking using Polyspace:

Polyspace provides MISRA violation results in an xml format. Each violation can be imported as a findinginto Squore.

5.28.3. UsageMISRA Rule Checking using Polyspace has the following options:

resultDir=[text]: Directory containing Polyspace MISRA results

unitByUnit=[booleanChoice]: Results have been generated unit by unit

The full command line syntax for MISRA Rule Checking using Polyspace is:

http://www.mathworks.fr/products/polyspace/








-d "type=Polyspace_MISRA,resultDir=[text],unitByUnit=[booleanChoice]"

5.29. Polyspace (plugin)

5.29.1. DescriptionPolyspace is a static analysis tool which includes a MISRA checker. It produces an xml output which canbe imported into Squore. Note that the data provider requires an extra download to extract the PolyspaceExport binary in <INSTALLDIR>/addons/tools/Polyspace_RTE. For more information, refer to theInstallation and Administration Guide's "Third-Party Plugins and Applications" section.

For more details, refer to the Polyspace (plugin) website: http://www.mathworks.fr/products/polyspace/

5.29.2. MeasuresSquore imports the following measures when running Polyspace (plugin):

Polyspace Verifier detects RTE (RunTime Error) such as Division by zero, Illegal Deferencement Pointer,Out of bound array index... Such information is turned into statistical measures at function level. Numberof Red (justified/non-justified), Number of Grey (justified/non-justified), Number of Orange (justified/non-justified), Number of Green

5.29.3. UsagePolyspace (plugin) has the following options:

resultDir=[text]: Directory containing Polyspace resultsunitByUnit=[booleanChoice]: Results have been generated unit by unit

The full command line syntax for Polyspace (plugin) is:

-d "type=Polyspace_RTE,resultDir=[text],unitByUnit=[booleanChoice]"

5.30. MISRA Rule Checking from QAC

5.30.1. DescriptionQAC identifies problems in C source code caused by language usage that is dangerous, overly complex, non-portable, difficult to maintain, or simply diverges from coding standards. Its CSV results file can be importedinto Squore.

For more details, refer to the MISRA Rule Checking from QAC website: http://www.phaedsys.com/principals/programmingresearch/pr-qac.html

5.30.2. MeasuresSquore imports the following measures when running MISRA Rule Checking from QAC:

Squore imports the findings from the results file and maps them to artefacts

5.30.3. UsageMISRA Rule Checking from QAC has the following options:


http://www.phaedsys.com/principals/programmingresearch/pr-qac.html

http://www.phaedsys.com/principals/programmingresearch/pr-qac.html






logDir=[text]: QAC Annotated File Directory

ext=[text]: QAC Annotated File Extension

The full command line syntax for MISRA Rule Checking from QAC is:

-d "type=QAC_MISRA,logDir=[text],ext=[text]"

5.31. Unit Test Code Coverage from Rational Test RealTime

5.31.1. DescriptionRational Test RealTime is a cross-platform solution for component testing and runtime analysis of embeddedsoftware. Squore uses the csv results file to generate metrics.

For more details, refer to the Unit Test Code Coverage from Rational Test RealTime website: http://www-01.ibm.com/software/awdtools/test/realtime/

5.31.2. MeasuresSquore imports the following measures when running Unit Test Code Coverage from Rational Test RealTime:

Squore creates several measures based on the counts from the csv file.

5.31.3. UsageUnit Test Code Coverage from Rational Test RealTime has the following options:

logDir=[text]: Path of the directory containing the RTRT '.xrd' files

excludedExtensions=[text]: Excluded file extensions

The full command line syntax for Unit Test Code Coverage from Rational Test RealTime is:

-d "type=RTRT,logDir=[text],excludedExtensions=[text]"

5.32. ReqIf

5.32.1. DescriptionRIF/ReqIF (Requirements Interchange Format) is an XML file format that can be used to exchangerequirements, along with its associated metadata, between software tools from different vendors.

For more details, refer to the ReqIf website: http://www.omg.org/spec/ReqIF/

5.32.2. MeasuresSquore imports the following measures when running ReqIf:

5.32.3. UsageReqIf has the following options:

http://www-01.ibm.com/software/awdtools/test/realtime/

http://www-01.ibm.com/software/awdtools/test/realtime/

http://www.omg.org/spec/ReqIF/






file=[text]: ReqIf file

The full command line syntax for ReqIf is:

-d "type=ReqIf,file=[text]"

5.33. SQLCodeGuard

5.33.1. DescriptionSQL Code Guard is a free solution for SQL Server that provides fast and comprehensive static analysis for T-Sql code, shows code complexity and objects dependencies.

For more details, refer to the SQLCodeGuard website: http://www.sqlcodeguard.com

5.33.2. MeasuresSquore imports the following measures when running SQLCodeGuard:

SQL Code Guard is a free solution for SQL Server that provides fast and comprehensive static analysis forT-Sql code, shows code complexity and objects dependencies.

5.33.3. UsageSQLCodeGuard has the following options:

xml=[text]: XML file containing SQLCodeGuard results

The full command line syntax for SQLCodeGuard is:

-d "type=SQLCodeGuard,xml=[text]"

5.34. SQuORE

5.34.1. DescriptionSQuORE is the source code analysis engine at the heart of the the Squore Server.

For more details, refer to the SQuORE website: http://www.squoring.com

5.34.2. MeasuresSquore imports the following measures when running SQuORE:

SQuORE metrics and findings are fully configurable depending on the analysis model you are using. Notethat the exact format for include/exclude shell patterns described below is as follows:

* Matches any sequence of characters in string, including a null string.

? Matches any single character in string.

[chars] Matches any character in the set given by chars. If a sequence of the form x-y appears inchars, then any character between x and y, inclusive, will match. On Windows, this is used with the -nocase option, meaning that the end points of the range are converted to lower case first. Whereas

http://www.sqlcodeguard.com

http://www.squoring.com






{[A-z]} matches '_' when matching case-sensitively ('_' falls between the 'Z' and 'a'), with -nocase this isconsidered like {[A-Za-z]}.

\x Matches the single character x. This provides a way of avoiding the special interpretation of thecharacters *?[] in pattern.

TipUse ; to separate multiple patterns.

. Note also that the analyser can output info and warning messages in the build logs. Recent additions tothose logs include better handling of structures in C code, which will produce these messages:

[Analyzer] Unknown syntax declaration for function XXXXX at line yyy to indicate that we whould havefound a function but, probably due to preprocessing directives, we are not able to parse it.

Analyzer] Unbalanced () blocks found in the file. Probably due to preprocessing directives, parenthesisin the file are not well balanced.

[Analyzer] Unbalanced {} blocks found in the file. Probably due to preprocessing directives, curly bracketsin the file are not well balanced.

TipYou can specify the languages for your source code by passing pairs of language and extensions tothe languages paramater. For example, a project mixing php and javascript files can be analysedwith:

--dp "type=SQuORE,languages=php:.php;javascript:.js,.JS"

5.34.3. UsageSQuORE has the following options:

languages=[multipleChoice]: Languages

genCG=[booleanChoice]: Generate control graphs

qualified=[booleanChoice]: Use qualified names

depth=[booleanChoice]: Limit the analysis depth to file only

scnode=[booleanChoice]: Add a 'Source Code' node

scnode_name=[text]: Name of the 'Source Code' node

compact_folder=[booleanChoice]: Compact folders having only one son

pattern=[text]: Exclude files whose contents match with PERL regexp

files_choice=[multipleChoice]: files whose name matches with

pattern_files=[text]: Shell-like wildcards e.g. '*-test.c'

dir_choice=[multipleChoice]: directories whose name matches with

pattern_dir=[text]: Shell-like wildcards e.g. 'Test_*'

clAlg=[booleanChoice]: Detect algorithmic cloning

clTxt=[booleanChoice]: Detect text cloning

clBw=[booleanChoice]: Use backward compatible algorithm

clFR=[text]: Cloning fault ratio (ignored for backward algorithm)

clOS=[booleanChoice]: Detect Open Source cloning

genTs=[booleanChoice]: Generate Textual stability






genAs=[booleanChoice]: Generate 'Algorithm' stability

additional_param=[text]: Additional parameters

The full command line syntax for SQuORE is:

-d "type=SQuORE,languages=[multipleChoice],genCG=[booleanChoice],qualified=[booleanChoice],depth=[booleanChoice],scnode=[booleanChoice],scnode_name=[text],compact_folder=[booleanChoice],pattern=[text],files_choice=[multipleChoice],pattern_files=[text],dir_choice=[multipleChoice],pattern_dir=[text],clAlg=[booleanChoice],clTxt=[booleanChoice],clBw=[booleanChoice],clFR=[text],clOS=[booleanChoice],genTs=[booleanChoice],genAs=[booleanChoice],additional_param=[text]"

5.35. SQuORE Import

5.35.1. DescriptionSQuOREImport is a data provider used to import the results of a Squore analysis into another Squore Server

For more details, refer to the SQuORE Import website: http://www.squoring.com

5.35.2. MeasuresSquore imports the following measures when running SQuORE Import:

SQuOREImport imports the measures of the original project into another project.

5.35.3. UsageSQuORE Import has the following options:

inputDir=[text]: Directory containing the SQuORE results files to be imported

The full command line syntax for SQuORE Import is:

-d "type=SQuOREImport,inputDir=[text]"

5.36. SQuORE Virtual Project

5.36.1. DescriptionSQuOREVirtualProject is a data provider that can use the output of several Squore projects to compile metricsin a meta-project composed of the import sub-projects.

For more details, refer to the SQuORE Virtual Project website: http://www.squoring.com/

5.36.2. MeasuresSquore imports the following measures when running SQuORE Virtual Project:

SQuOREVirtualProject aggregates the measures of all the imported Squore projects.

5.36.3. UsageSQuORE Virtual Project has the following options:

output=[text]: Enter paths to SQuORE output files (delimiter = ';')

The full command line syntax for SQuORE Virtual Project is:

http://www.squoring.com

http://www.squoring.com/






-d "type=SQuOREVirtualProject,output=[text]"

5.37. StyleCop

5.37.1. DescriptionStyleCop is a c# code analysis tool. Its XML output is used by Squore to create findings.

For more details, refer to the StyleCop website: http://archive.msdn.microsoft.com/sourceanalysis

5.37.2. MeasuresSquore imports the following measures when running StyleCop:

All findings found in the XML file are imported into Squore and attached to a particular line of code.

5.37.3. UsageStyleCop has the following options:

xml=[text]: XML file containing StyleCop results

The full command line syntax for StyleCop is:

-d "type=StyleCop,xml=[text]"

5.38. StyleCop (plugin)

5.38.1. DescriptionStyleCop_auto (running with StyleCop 4.7) is a c# code analysis tool. Its XML output is used by Squore tocreate findings.

For more details, refer to the StyleCop (plugin) website: http://archive.msdn.microsoft.com/sourceanalysis

5.38.2. MeasuresSquore imports the following measures when running StyleCop (plugin):

All findings found in the XML file are imported into Squore and attached to a particular line of code.

5.38.3. UsageStyleCop (plugin) has the following options:

sln=[text]: Solution (.sln) - all files if empty

The full command line syntax for StyleCop (plugin) is:

-d "type=StyleCop_auto,sln=[text]"

5.39. Tessy

http://archive.msdn.microsoft.com/sourceanalysis

http://archive.msdn.microsoft.com/sourceanalysis






5.39.1. DescriptionTessy is a tool automating module/unit testing of embedded software written in dialects of C/C++. Tessygenerates an XML results file which can be imported into Squore.

For more details, refer to the Tessy website: http://www.hitex.com/index.php?id=172

5.39.2. MeasuresSquore imports the following measures when running Tessy:

Tessy results are imported and made available as base measures in Squore

5.39.3. UsageTessy has the following options:

resultDir=[text]: Directory containing Tessy index.xml result files

The full command line syntax for Tessy is:

-d "type=Tessy,resultDir=[text]"

5.40. oslc cm

5.40.1. DescriptionOSLC-CM allows retrieving information from Change Management systems following the OSLC standard.Note that this data provider requires extra perl modules to be available on Linux machines:HTML::TreeBuilder, HTTP::Server::Simple, HTTP::Server::Simple::CGI, WWW::Mechanize, Date::Parse,Date::Language, Date::Format and Time::Zone.

For more details, refer to the oslc cm website: http://open-services.net/

5.40.2. MeasuresSquore imports the following measures when running oslc cm:

Change Requests and their status

5.40.3. Usageoslc cm has the following options:

server=[text]: Change Server

query=[text]: Query

properties=[text]: Query Properties

login=[text]: Login

password=[password]: Password

The full command line syntax for oslc cm is:

-d "type=oslc_cm,server=[text],query=[text],properties=[text],login=[text],password=[password]"

http://www.hitex.com/index.php?id=172

http://open-services.net/






5.41. pep8

5.41.1. Descriptionpep8 is a tool to check your Python code against some of the style conventions in PEP 8, as defined on http://legacy.python.org/dev/peps/pep-0008/.

For more details, refer to the pep8 website: https://pypi.python.org/pypi/pep8

5.41.2. MeasuresSquore imports the following measures when running pep8:

pep8 results are imported by Squore and produce findings on Python code.

5.41.3. Usagepep8 has the following options:

csv=[text]: CSV file containing Pep8 results

The full command line syntax for pep8 is:

-d "type=pep8,csv=[text]"

5.42. pylint

5.42.1. DescriptionPylint is a Python source code analyzer which looks for programming errors, helps enforcing a coding standardand sniffs for some code smells (as defined in Martin Fowler's Refactoring book).

For more details, refer to the pylint website: https://pypi.python.org/pypi/pylint

5.42.2. MeasuresSquore imports the following measures when running pylint:

Pylint results are imported by Squore and produce findings on Python code.

5.42.3. Usagepylint has the following options:

csv=[text]: CSV file containing Pylint results

The full command line syntax for pylint is:

-d "type=pylint,csv=[text]"

http://legacy.python.org/dev/peps/pep-0008/

http://legacy.python.org/dev/peps/pep-0008/

https://pypi.python.org/pypi/pep8

https://pypi.python.org/pypi/pylint






Appendix A. Reference pagesNameinstall — Squore CLI install script

Synopsisinstall [-v ] [-s server_url] [-u user] [-p password] [options...]

DescriptionInstalls and configures Squore CLI.

The most common options when installing Squore CLI are -s, -u and -p, to configure the server URL, userand password used to connect to the server. These details will be stored on the machine so that the passworddoes not have to be passed again on the command line for this user account. The -N disables the automaticsynchronisation of the configuration folders with the server at the end of the installation. This can also belaunched manually later on if needed.

Options-s server_url (default: http://localhost:8180/SQuORE_Server) The URL of Squore

Server that Squore CLI will connect to after installation.

-u user (default: demo) The username to use to connect to Squore Server.

-p password (default: demo) The username to use to connect to Squore Server.

-N Do not synchronise client with server

-v Turn on verbose mode






IndexSymbols* What's New in Squore 2014-B?

deprecation of --language and --extensionsparameters and, 17Specify a custom date/time for your analysis, 16Use the ALL_TYPES artefact type in filters to exportdata for all artefact types in the output XML., 17Using one Squore CLI installation for multipleusers, 12

Aadd-credentials.sh, 12

CConfiguration

Configuring the client's work folders, 11Using one Squore CLI installation for multipleusers, 12

Continuous Integration, 13

DData Providers

AntiC, 24Bullseye Code Coverage, 24CheckStyle, 27CheckStyle (plugin), 28CheckStyle for SQALE (plugin), 28CodeSonar, 29Coverity, 30CPD, 25CPD (plugin), 25CPPCheck, 26CPPCheck (plugin), 26CPPTest, 27FindBugs, 31FindBugs (plugin), 31FxCop, 32GCov, 32GnatCheck, 33GnatCompiler, 33Jacoco, 34JUnit, 34Klocwork, 35MISRA Rule Checking from QAC, 39MISRA Rule Checking using PC Lint, 36MISRA Rule Checking using Polyspace, 38NCover, 35Oracle PLSQL compiler Warning checker, 36oslc cm, 45pep8, 46PMD, 37

PMD (plugin), 37Polyspace, 38Polyspace (plugin), 39pylint, 46ReqIf, 40SQLCodeGuard, 41SQuORE, 41SQuORE Import, 43SQuORE Virtual Project, 43StyleCop, 44StyleCop (plugin), 44Tessy, 44Unit Test Code Coverage from Rational TestRealTime, 40

Disk Space, 3

IInstaller

Linux, 10Windows, 5

JJava, 3

MMemory, 3

PPrerequisites, 3

RRepository Connectors

ClearCase, 19CVS, 19Folder Path, 19Git, 20MKS, 20Multiple Source Nodes, 22Perforce, 20SVN, 21Synergy, 21TFS, 22Zip File, 19

VversionPattern, 18

command line interface - support.squoring.com · squore 14-b-sp4 command line interface reference :...

Documents