Using CodeMRI® Platform to Create a Portfolio

Owned by Sean Gilliland (Unlicensed)
Last updated: May 07, 2020
4 min read

Overview

This article will discuss end-to-end steps for creating a new Portfolio in both the Local and Distributed cases.

Creating a Portfolio

Note: Please see the CodeMRI® Platform instructions for installation and configuration if necessary. These instructions assume an operating instance of CodeMRI® Platform is already configured.

Local Case

  1. Use the CodeMRI® Platform to add a new Project to your DataVault. In this example, we are adding a new project named “axis2” to hold our axis2 software system versions.

    This new project can be verified by using the “vault list” command. In this example, we see an empty “axis2” project and a “Linux” project with one system added to it.

  2. Select this new project to begin adding new systems. In this example, we select the newly added axis2 project.

  3. Use the CodeMRI Platform to add a new System under this project to your DataVault. Configure this System to point to the source code directory to be scanned. In this example, we are configuring the Platform to add a new software system named “axis2” version “1.0” to the Portfolio with the displayed path to the source code.

    Repeat steps 1 through 3 as necessary until all software systems have been added to the DataVault.

  4. Once all software systems have been added to the DataVault, use “vault list” to review that all systems have been added as expected. In this case we have both axis2 and a version of Linux in our example Portfolio.

  5. Use the “select” command to select all systems to be included in the Portfolio from the DataVault. In this example we are adding all systems to the selection set.

    You may use “vault list” again here to verify your selection set includes all systems to be included in the Portfolio.

  6. Once all systems to be included in the Portfolio are selected run the “produce_portfolio” job to finalize and create the Portfolio. Source code will be scanned and included if it has not already been analyzed.

  7. Once complete your Portfolio will be ready in the “reports” directory to view.

Distributed Case

When including information gathered from remote sites using the CodeMRI® Scanner or other Platform installations using the “pack” command certain other steps will be necessary to unpack and include this metadata in a Portfolio.

  1. Locate the packs to be included in the datavault. Packs are archives of metadata information that can be used to add a system to a DataVault instead of performing a fresh scan from source code.

  2. Once located use the CodeMRI® Platform to run the “unpack” command indicating the pack to be processed. A single pack, or a folder containing multiple packs may be used.

  3. Once unpacked, run “vault list” to verify all software systems have been added to the vault as expected. In this example, we have unpacked the axis2 software system into a vault previously containing only Linux.

  4. Use the “select” command to select all systems to be included in the Portfolio from the DataVault. In this example we are adding all systems to the selection set.

    You may use “vault list” again here to verify your selection set includes all systems to be included in the Portfolio.

  5. Once all systems to be included in the Portfolio are selected run the “produce_portfolio” job to finalize and create the Portfolio. Source code will be scanned and included if it has not already been analyzed.

  6. Once complete your Portfolio will be ready in the “reports” directory to view.