{"id":1757,"date":"2023-06-06T11:20:26","date_gmt":"2023-06-06T11:20:26","guid":{"rendered":"https:\/\/community.5gasp.eu\/?page_id=1757"},"modified":"2023-06-22T10:03:04","modified_gmt":"2023-06-22T10:03:04","slug":"5gasp-cli-for-creating-testing-descriptors-tutorial","status":"publish","type":"page","link":"https:\/\/community.5gasp.eu\/index.php\/5gasp-cli-for-creating-testing-descriptors-tutorial\/","title":{"rendered":"5GASP CLI for creating Testing Descriptors Tutorial"},"content":{"rendered":"\n

The 5GASP command line interface was developed to facilitate the creation of testing descriptors.<\/p>\n\n\n\n

Creating a Virtual Environment<\/h2>\n\n\n\n

First, we recommend using a virtual environment. In this example, we will be using pyenv<\/em><\/a>. Now, let’s create the virtual environment by running the following command:<\/p>\n\n\n\n

pyenv virtualenv 3.9.14 5gasp-cli-tutorial<\/code><\/pre>\n\n\n\n
Now that it was created, let’s activate it:<\/p>\n\n\n\n
pyenv shell 5gasp-cli-tutorial<\/code><\/pre>\n\n\n\n
Installing the CLI<\/h2>\n\n\n\n
After activating the venv, we need to install the CLI package, for that, we will be using pip<\/em><\/a> which is the package installer for Python.<\/p>\n\n\n\n
We simply need to type:<\/p>\n\n\n\n
pip install 5gasp-cli<\/code><\/pre>\n\n\n\n
CLI<\/h2>\n\n\n\n
At this moment, the CLI has three features\/commands:<\/p>\n\n\n\n
    \n
  • list test beds<\/li>\n\n\n\n
  • list available tests<\/li>\n\n\n\n
  • create testing descriptor<\/li>\n<\/ul>\n\n\n\n
    Listing the Test Beds<\/h2>\n\n\n\n
    Let’s dive into the first command.<\/p>\n\n\n\n
    If we wish to see the available test beds, we can do it by running:<\/p>\n\n\n\n
    5gasp-cli list-testbeds<\/code><\/pre>\n\n\n\n
    \"\"<\/figure>\n\n\n\n
    As we can see, the available test beds were listed. From here, we can also see the available tests for a specific test bed.<\/p>\n\n\n\n
    \"\"<\/figure>\n\n\n\n
    Listing the Available Tests<\/h2>\n\n\n\n
    Another feature of the CLI is the ability to list all the available tests, as well as their parameters. We can use this feature by running:<\/p>\n\n\n\n
    5gasp-cli list-available-tests<\/code><\/pre>\n\n\n\n
    Creating a Testing Descriptor<\/h2>\n\n\n\n
    Now, the final and most complex feature: creating a testing descriptor.<\/p>\n\n\n\n
    We can access it by running:<\/p>\n\n\n\n
    5gasp-cli create-testing-descriptor<\/code><\/pre>\n\n\n\n
    This command has two options:<\/p>\n\n\n\n
      \n
    • output-filepath: specifies the path to the created descriptor (can be a directory or a file);<\/li>\n\n\n\n
    • infer-tags-from-nsd: one or more NSDs (Network Service Descriptors) can be passed to infer connection point tags from.<\/li>\n<\/ul>\n\n\n\n
      In this example, we will be passing both options, although they are not required.<\/p>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
      Note<\/strong>: Currently, the 5GASP CLI only supports inferring connection point tags when they refer to a VNF, CNF-related ones are not yet supported.<\/p>\n\n\n\n
      For a connection point, there are also template tags that can be defined that shall be rendered after the deployment of the Network Application.<\/p>\n\n\n\n
      If no NSD is passed as an option, there will be no inferred connection points, in that case, all the added test variables’ parameters will have to be manually input.<\/p>\n\n\n\n
      When creating a testing descriptor, firstly we need to specify the network application and the network service’s names, as well as the testbed in which we want to validate your Network Application.<\/p>\n\n\n\n
      Following, this menu is presented with the available options for the creation of a testing descriptor.<\/p>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
      When adding a new test case, if the variable can be injected by the NODS. We can choose a connection point (CP) and its template to be injected.<\/p>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
      For demonstration purposes, we added two test cases, as can be seen on the picture below.<\/p>\n\n\n\n
      <\/p>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
      The CLI also allows us to choose if we want the defined test cases to be executed in a specific order or a random one.<\/p>\n\n\n\n
      Finally, the created testing descriptor is presented and saved.<\/p>\n\n\n\n
      \"\"<\/figure>\n\n\n\n
      These are the current features of the 5GASP CLI, with more to come.<\/p>\n\n\n\n
      If you want to know more, you can check the CLI\u2019s tutorial video:<\/p>\n\n\n\n
      \n