Task: Rename an Analysis with a Shell Script

• Permissions Required
• Other Requirements
• The Renaming Script
• Using the Script
• Modifying the Script
• Writing Other Scripts
• Running Scripts Automatically
• Links

Permissions Required

The script requires that special user Anonymous has the following permissions for the analysis A of interest.

• ANALYSIS_READ A
• ANALYSIS_WRITE A

See Modifying the Script for information on modifying the script to specify credentials for a non-Anonymous user with the required permissions.

Other Requirements

The Renaming Script

The following script will change the name of

• the analysis whose analysis ID matches the second argument passed to the script,
• on the hub specified in the first argument to the script,
• to the value specified in the third argument to the script.

#! /bin/sh -e

if [ $# -ne 3 ]; then
    echo "Usage: $0 HUB ANALYSIS_ID NEW_NAME"
    exit 1
fi

HUB=$1
ANALYSIS_ID=$2
NEW_NAME=$3
ANALYSIS_HTML_URL="${HUB}/analysis/${ANALYSIS_ID}.html"
CURL_CMD=curl

fetch(){
   "$CURL_CMD" -d new_name="$1" "$2"
}

fetch "${NEW_NAME}" "${ANALYSIS_HTML_URL}"

This shell script uses an HTTP POST request to send the new analysis name to the hub, just as the web form on the Analysis page would do if you were changing the name in the web GUI. It outputs the updated Analysis page HTML.

Using the Script

To use this script with your hub, do the following.

1. Copy rename_analysis.sh to a suitable directory. The remainder of these instructions will refer to this directory as rundir.
2. Run the script:
   cd rundir
   ./rename_analysis.sh protocol://host:port aid newname
   where

   protocol	is the protocol for your hub: http or https.
   host:port	is the location of your hub.
   aid	is the analysis ID for the analysis whose name you wish to change. You can find the analysis ID: in the URL specified at the end build/analysis command output, which will be of the form http://hub_location/analysis/analysis_id.html, or in file path/to/projname.prj_files/aid.txt, where path/to/projname.prj_files/ is the analysis directory, or by running the following command, where path/to/projname.prj_files/ is the analysis directory codesonar analysis_id.py path/to/projname.prj_files/ or in the Analysis Details section of the corresponding Analysis page.
   newname	is new name you wish to set for the analysis. It must be URL-encoded.

   The script will output information about its progress.
3. Open the analysis page protocol://host:port/analysis/aid.html in your web browser to confirm that its name has changed (or look at the top of the output). If it hasn't, the most likely explanation is that Anonymous does not have ANALYSIS_WRITE permission for the analysis.

Invocation Example

Using the hub at http://[::1]:7341, change the name of the analysis with ID 3 to "My Renamed Analysis":

• Note the URL-encoding of the new name.

Troubleshooting

fetch(){
   "$CURL_CMD" -v -d new_name="$1" "$2"
}

Modifying the Script

You may wish to make one or more of the following modifications.

• Stop printing the updated HTML file to output
• Read analysis ID from analysis directory
• Provide credentials for a non-Anonymous user

Stop printing the updated HTML file to output

If you don't want to see the updated HTML file as part of your script's output, you can redirect it to the null location by modifying your curl command. Note that if you make further changes that you need to debug later, you may wish to lift this suppression at least temporarily.

1. Edit rename_analysis.sh so that curl is invoked with the -o flag and a suitable value.

   fetch(){
      "$CURL_CMD" -o /dev/null -d new_name="$1" "$2"
   }

Read analysis ID from analysis directory

Instead of specifying the analysis ID on the command line, you can change the script to read the analysis directory from the command line and then read the most recent analysis ID from the analysis directory.

1. Edit rename_analysis.sh so that the line setting ANALYSIS_ID is replaced with three lines:

   ANALYSIS_DIR=$2
   CSONAR_CMD=codesonar
   ANALYSIS_ID=$("$CSONAR_CMD" analysis_id.py "$ANALYSIS_DIR" | tr -d '\r')
   

   If it is not in your PATH, adjust the setting of CSONAR_CMD to include the full path to your codesonar executable.
2. When you invoke the script, specify the analysis directory as the second argument.

   For example: using the hub at http://[::1]:7341, rename the analysis whose analysis directory is /myprojects/projectX.prj_files/ to "Another Renamed Analysis".

   ./rename_analysis.sh http://[::1]:7341 /myprojects/projectX.prj_files/ Another%20Renamed%20Analysis

Provide credentials for a non-Anonymous user

If your hub is configured so that special user Anonymous does not have the required permissions, you will need to edit the script to submit credentials for a suitable hub user account.

See CodeSonar HTTP API: Authentication for more information on authentication strategies.

Running Scripts Automatically

You can use your system tools to arrange for the shell script to be run automatically.

5 2 * * * /path/to/rename_analysis.sh http://red:7341 `cat /home/projectX.prj_files/aid.txt` My%20New%20Name

(Note: many use cases for automatic renaming could be addressed more straightforwardly by using the -name option to set the analysis name when the analysis is performed.)

Links

• Typical CodeSonar Tasks
• HTTP API Documentation
• The CodeSonar Hub
• CodeSonar GUI Reference