Creating a Project

Creating a project in Squore is as easy as following a wizard that will prompt you for information about the source material to analyse, and the external Data Providers to add to the analysis results.

The example below assumes that the source code for the sample project used is available on a network share. The path to the source files to analyse is relative to the server.

In order to create a project for the sample application Neptune2, follow these steps:

  1. Access http://localhost:8180 in your browser. The log-in page appears.

  2. Log in as the demo user with the login/password combination demo/demo.

  3. Click the Log in button. You are presented with the Squore Home page.

  4. Click Projects to switch to the projects view and click Create Project to create the Neptune2 project.

  5. The Wizard Selection screen appears. Project wizards allow you to use different analysis models and tools to analyse your projects. For this demo, click the Software Analytics wizard to start creating the project.

    SUM wizardSelection
    Figure 1. The Wizard Selection screen

    If your Squore installation has been customised to provide only one project wizard, the Wizard Selection is skipped.

  6. The General Information screen appears.

    SUM ProjectInformation
    Figure 2. The General Information screen

    On this screen, you can enter the information relative to your project in the Project Identification section

    The Version Date field allows specifying a custom date for the analysis, so that different analyses can be placed correctly on a timeline later for certain charts in the dashboard. If you leave it empty, then the actual time at which you are running the analysis is used.

    The Software Analytics model offers extra parameters below the Project Identification section, but you can ignore them for now.

  7. Click the Next button. The Data Providers screen is shown:

    SUM SourceCode
    Figure 3. The Data Providers options screen

    This screen allows configuring the repository locations and tools that will be used in your analysis. Set the source code files option to Folder. In the Datapath text box, type the path to the Neptune2 source code: //server/share/samples/c/Neptune/W25.

    The only Data Provider used in our analysis is Squore Analyzer, the source code analyser, so you can leave all the other tools unchecked.

    If you want to learn more about the available Repository Connectors and Data Providers, consult Repository Connectors and Data Providers sections.

    In the Squore Analyzer parameters, ensure that C is one of the programming languages selected, as shown below:

    SUM Providers
    Figure 4. The Squore Analyzer Data Provider parameters

  8. Click the Next button to read the Rules Edition screen. This screen allows you to tweak the ruleset available in the analysis model.

    SUM wizardStepRulesEditor
    Figure 5. The Rules Edition screen

    The table displays the entire model’s ruleset, which you can filter and sort by Data Provider or category. Each rule can be turned on or off, and you can click the Edit button to adjust the categories for each rule. Note that any modifications from the original configuration are displayed with an asterisk.

    Click the Next button when you are satisfied with your modifications. Note that your modifications are applied for any subsequent analysis of this project and do not affect other projects using the same model.

    This screen may not be enabled in your wizard, as your administrator may have disabled it in your configuration. Your administrator can also decide to make modifications to the ruleset that apply to any project created with this model using the Ruleset Editor. Consult Ruleset Editor and Using Ruleset Templates to learn more.

  9. Before launching the analysis, a summary of your selections is displayed. Review the information and click Run to confirm the project creation.

    SUM wizardSummary
    Figure 6. The Rules Edition screen

    The summary page lists all the options you specified for the project creation and also allows outputting them in various formats so that you can repeat the project creation in command line. For more information about reusing the project build parameters in a different context, consult the documentation section: Creating projects via command line.

    SUM wizardCliParameters
    Figure 7. Squore Agent command line

Checking project status

When the project analysis completes, Squore shows you the list of projects. Neptune2 appears in the list, together with information about the current version and its computed rating:

SUM ProjectList
Figure 8. The projects list

To consult the results of the analysis, click on the project name to view the Squore Dashboard. More information on how to read the Dashboard is available in Exploring Analysis Results.

In the last column you can see the status of the last executed task. If the status is at Successful then it’s creation was completed successfully.

By clicking on the last task status you are redirected to the Project’s Tasks page :

SUM ProjectTasks
Figure 9. The Project’s Tasks page

In this page you have access to the list of all the tasks executed on this project, as well as their logs : version builds, reapply model, cloning, etc…​

Creating a new version

Adding a version to an already-existing project is a simple procedure that is carried out from the Projects page.

Follow these steps to create version 2 of your project:

  1. After logging into Squore, click on Projects.

  2. Click the Build icon (SUM NewVersionIcon) for the Neptune2 project in order to access the source code file options.

  3. The first screen of the wizard enables you to specify the version name and to modify some of the project attributes if necessary.

    SUM NewVersionStep1
    Figure 10. Parameters For the New Version of Neptune2

  4. Click the Next button to reach the project language and source settings screen. On this screen, you can modify the path to the source code and point to the newer version. Note that by default, Squore displays the path used when analysing the last version. Leave the path as it was for version 1. We are going to create a version that analyses the same code in this example. If you scroll down to the code analysis option, you will notice that some of them are now disabled. This is because the project configuration was set in version 1 and is not allowed to be modified in subsequent analyses. This ensures that your project is scored using the same criteria every time you analyse new code.

    SUM NewVersionStep2
    Figure 11. Unavailable options when creating version 2 of a project

    You can add new sources to the project at this stage if needed. Read more about projects using sources spread over multiple locations in Pulling sources from multiple locations.

  5. Click Finish and Run to launch the analysis of Neptune2 V2. When the analysis finishes, Neptune2 V2 will be listed in the list of projects on the Projects page.

Organizing projects

By default, projects are sorted out according to their analysis model in the Project Portfolios.

SUM default organisation
Figure 12. Project Portfolios default organization

But it is possible to create groups and subgroups in order to organise the project list.

SUM custom organisation
Figure 13. Project Portfolios custom organization

To do so, click on "Manage" for a given project and in the "Project Properties" tab, fill in the "Group" field :

SUM edit project group
Figure 14. Edit project’s group

It is possible to create subgroups as well, just type in the full path to your group : "myGroup/mySubgroup".

To remove a project from a group just delete the content of the "Group" field. If a group becomes empty after removing its last project, it will be automatically removed from the Project Portfolios.

Reapply Model on projects

This feature enables you to apply a new model, or an updated one, on an already existing project. This is done by using the project data in the database, without executing Repository Connectors and Data Providers.

Go to the "Projects" page, in the sandwich menu from the desired project, click "Reapply Model":

SUM reapplyModelButton
Figure 15. Reapply model on an existing project

Defining roles for your team members

When you create a project, you become its owner, and remain the only user who can view it in Squore by default. In order to make it visible to more users, the project owner has to create a project team of users and groups and assign them project roles. This is done in the Manage project page of a project in the Team tab, as shown below:

SUM emptyTeam
Figure 16. The Team tab

The project scope can be set directly from the command line when creating a new project, if you use the teamUser and teamGroup options. For more details, refer to the Command Line Guide.

In order to give visibility to the user admin over the projects created by the user demo, follow these steps:

  1. Log in as the demo user and go to the Projects page.

  2. Click the Manage project icon (SUM ManageIcon) for the project Earth

  3. Click on the Team tab to view the project team.

  4. Click Add member and type admin in User/Group field. The list will show all users and groups available matching the search term.

  5. Then select the project role you want to assign the user within this project. Select Guest from the list.

    SUM teamSearch
    Figure 17. The users and groups matching admin

  6. Click Add member to apply your changes.

The admin user can now log in and will see the Earth project in their Explorer.

For more information about project roles, consult Project Roles.

If you want to configure the rest of the sample projects the way you configured Earth, you can copy the project team to another project:

  1. Click on Manage project > Team for the project Mars

  2. Select Earth from the Load from Project dropdown in the pop-up and click Load.

  3. The users and their project roles have now been copied as they were set up in the Earth project. You can make adjustments or click Apply to confirm your changes.