Task: Delete a Project with a Python Script

• Permissions Required
• Other Requirements
• The Deletion Script
• Using the Script
• Modifying the Script
• Writing Other Scripts
• Links

Permissions Required

The script requires that special user Anonymous has the following permissions for the project P and its analyses.

• ANALYSIS_DELETE a for all analyses a of P.
• PROJECT_DELETE P

If you will be extending the script to derive the project ID from an analysis directory for some analysis A of the project, you will also need the following permissions for A.

• ANALYSIS_READ 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

Use the cURL shipped with CodeSonar: $CSONAR/third-party/curl/inst/bin/curl, where $CSONAR is the CodeSonar installation directory. Either:

• add $CSONAR/third-party/curl/inst/bin/ to the front of your PATH,
  or
• edit the script so that the setting of curl_cmd specifies the full path to $CSONAR/third-party/curl/inst/bin/curl.

The Deletion Script

The following script will delete

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

import argparse
import os
import subprocess

# Delete the specified project from the specified hub
def del_project(hubaddr, project_id):
    curl_cmd = ['curl']

    delete_args = ['-L', 
                   '--cookie-jar','cookies.txt',
                   '-d', f'remove_project_id={project_id}',
                   hubaddr]
    subprocess.check_call(curl_cmd + delete_args)


# Set up.
def go():
    parser = argparse.ArgumentParser(
        description=('Delete a project from a CodeSonar hub,'
                     + 'as specified by the command-line arguments.'))
        
    parser.add_argument("hub",
                        help="The hub URL.")
    parser.add_argument("pid",
                        help="The project ID for the project to delete.")
    args = parser.parse_args()

    allargs = (args.hub, args.pid)
    if not any([a is None for a in allargs]):
        del_project(*allargs)

go()

This Python script uses an HTTP POST request to perform the deletion: the POST request is for the hub Home page and must specify remove_project_id=pid, where pid is the project ID of the project to be deleted. It outputs the HTML landing page that reports successful deletion.

The hub functionality for deleting an analysis entails several HTTP redirects across a single session. When you are using an anonymous session, as here, it must be tracked using cookies. The script uses cURL options to ensure that the redirects and cookies are properly accounted for:

• -L instructs cURL to follow redirects.
• --cookie-jar cookies.txt instructs cURL to use local file cookies.txt to manage any cookies involved in completing the command.
  File cookies.txt will be created in your working directory, if it does not already exist.

Inspect the HTML source for a Project page to see the remove_project_form element and how its attributes and sub-elements correspond to the HTTP POST request constructed by the script.

Using the Script

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

1. Copy delete_project.py to a suitable directory. The remainder of these instructions will refer to this directory as rundir.

   Make sure you have full file permissions in rundir, and that using file rundir/cookies.txt to manage cookies for this task will not cause conflicts with other uses of rundir. If there is a problem, either:

   • select a different rundir, or
   • edit the script to specify a different file name with --cookie-jar.
2. Run the script:
   cd rundir
   python delete_project.py protocol://host:port pid
   where

   protocol	is the protocol for your hub: http or https.
   host:port	is the location of your hub.
   pid	is the project ID for the project whose name you wish to change. You can find the project ID: in the GUI Project page URL, which will be of the form http://hub_location/project/project_id.html, or by deriving it based on the analysis ID from the most recent analysis of the project, which in turn is available: 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 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 file path/to/projname.prj_files/aid.txt, where path/to/projname.prj_files/ is the analysis directory. For details, see Derive the project ID from the analysis directory, below.

   The script will output information about its progress.
3. Attempt to open the project page protocol://host:port/project/pid.html in your web browser to confirm that the project is no longer available.

Invocation Example

Using the hub at http://[::1]:7341, delete the project with ID 3:

Troubleshooting

curl_cmd=['curl', '-v']

curl_cmd=['curl', '-k']

Modifying the Script

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

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

Stop printing the resulting HTML file to output

If you don't want to see the final HTML file notifying you of successful deletion 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 delete_project.py to add the -o flag with a suitable value to the definition of delete_args:

   delete_args = ['-o', os.devnull,
                  '-L',              
                  '--cookie-jar', 'cookies.txt',
                  '-d', f'remove_project_id={project_id}',
                  hubaddr]

Derive the project ID from the analysis directory

Instead of specifying the project ID on the command line, you can change the script to read the analysis directory from the command line and derive the project ID by reading the most recent analysis ID from the analysis directory, requesting the corresponding Analysis page from the hub, then reading the project ID from the Analysis page.

Because this approach requires the Analysis page for the analysis A in question, you must have the following permissions for A in addition to the required project permissions.

• ANALYSIS_READ A

Once you have verified that you have these permissions, proceed as follows.

1. In function go(), replace line

   parser.add_argument("pid", help="The project ID for the project to delete.")

   with a line adding an adir argument.

   parser.add_argument("adir", help="The analysis .prj_files directory.")
   

2. In function go(), change the definition of allargs to:

   allargs = (args.hub, args.adir)
   

3. Modify the del_project() function header, and add two new lines to the very beginning of the function definition.

   def del_project(hubaddr, analysis_dir):
       with open(os.path.join(analysis_dir,'aid.txt'),'r') as aidfile:
           analysis_id=aidfile.read()
   

4. Insert the following code after the definition of check_page() and before the line setting delete_args.

       analysis_html_url = f'{hubaddr}/analysis/{analysis_id}.html'
   
       # Download and scrape Analysis HTML page for a project ID,
       # which will be that of the analyzed project.
       analysis_dl=subprocess.Popen(curl_cmd + [analysis_html_url],
                                   stdout=subprocess.PIPE)
       analysis_page=analysis_dl.communicate()[0]
       pid_match=re.search(r'<a href="/project/(\d+).html">',
                           analysis_page)
       if pid_match is None:
           print 'Could not get analysis page', analysis_html_url
           print 'Make sure you have ANALYSIS_READ permission for this analysis.'
           exit(1)
   
       project_id = pid_match.group(1)
   

5. When you invoke the script, specify the analysis directory as the second argument.

   For example: using the hub at http://[::1]:7341, delete the analysis whose analysis directory is /myprojects/projectX.prj_files/.

   python delete_project.py http://[::1]:7341 /myprojects/projectX.prj_files/

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.

Links

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