MetadataTest Class:

The MetadataTest class inherits from BaseTest class, and contains the main methods to create and run the test commands.

class MetadataTest( configFile=None, createFiles=False, root=True, https=True, davs=True )

A configuration file can be passed upon instantiation of the subclasses containing the endpoint, file path and optional port.

Optionally, specifying a directory, file name(s) and file size(s) in the config file and instantiating with createFiles=True will generate these files in the provided directory.

To exclude up to two of the protocols from being used, they can be toggled to False when instantiating the subclass

 

MetadataTest Methods:

method genScenarios( action, sourcePath=None, destinBaseNm=None, xrdArgs=None, gfalArgs=None, timeout=None, XROOTD_ECHO=False, INT_MANAGER=False )

This method generates and runs commands for a given functionality, for each protocol and endpoint combination

     Parameters:

  • action (string) – Functionality of the command. Expects a string of one of the following:
    • copy – copy a single file
    • checksum – get checksum of one or more destination files
    • delete – delete a single destination file
    • bulk-copy – transfer multiple files to destination one-by-one
    • bulk-delete – delete multiple destination files
    • stat – compare metadata categories on destination file to expected categories
  • sourcePath (string, list) – Path to local file. Can be list when action = readv, load or bulk-copy
  • destinBaseNm (string, list) – Base name of file on endpoint. Can be list when action = checksum, readv or bulk-delete
  • xrdArgs (string, optional) – Extra flag(s) to be added to the generated base command of the action, for XRootD commands
  • gfalArgs (string, optional) - Extra flag(s) to be added to the generated base command of the action, for gfal2 commands
  • timeout (int, optional) – Optional timeout for all commands, overrides default (5 seconds)
  • XROOTD_ECHO (bool, optional) – Sets endpoint to redirector: xrootd.echo.stfc.ac.uk
  • INT_MANAGER (bool, optional) – Sets endpoint to redirector: echo-internal-manager01.gridpp.rl.ac.uk

     Returns:
         Returns a dictionary containing the command outputs required by the given action.
         All actions will return a dictionary containing the following key:value pairs:

  • ‘cmdOuts’: [(returncode, stdout, stderr), … (returncode, stdout, stderr)] – Returncode, stdout and stderr in a tuple for each command that was run
  • ‘IDs’: [‘example_ID1’, … ‘example_IDx’] – ID for each command/scenario in the format ‘protocol:endpoint-file’

     Additionally, the following actions will also contain extra key:value outputs:

     Copy and bulk-copy:

  • ‘srcsums’: [(file1-checksum, file2-checksum), … (file1-checksum, file2-checksum)] – Checksum for each local file. When multiple files are passed, the ‘srcsums’ and ‘cmdOuts’ for each file is grouped into a tuple.

     Checksum:

  • ‘cmdOuts’: [(file1-stderr, file2-stderr), … (file1-stderr, file2-stderr)] – Standard error (without returncode and stdout) for each command that was run. Grouped into tuples if multiple files are passed to destinBaseNm.
  • ‘destsums’: [((file1-checksum, endian-ness), (file2-checksum, endian-ness)), … ((file1-checksum, endian-ness), (file2-checksum, endian-ness))] – Checksum and Endian-ness for each destination file. Grouped into tuples if multiple files are passed to destinBaseNm.

     Stat:

  • ‘cmdOuts’: [(returncode, stdout, stderr, categories, expectedCategories), … (returncode, stdout, stderr, categories, expectedCategories)] – Returncode, stdout, stderr, list of metadata categories of file on destination, list of expected categories

     Return type:
          dictionary