Remove users by user prefix

services/create_users.sh

+#!/bin/bash
+LOCAL=true
+
+# User to create
+TOTAL_USERS=1
+USERNAME_PREFIX=
+USER_PASSWORD=
+
+help() {
+  echo "Usage: $1 <options>"
+  echo "       -u : User prefix to use"
+  echo "       -p : Password to set for user"
+  echo "       -l : Local usage of script (default true)"
+  echo "       -t : Total user to create (default 1)"  
+  echo "       -h : show this help"
+  exit 1
+}
+
+# Read params
+while getopts ":u:p:l:t:h" opt; do
+  case $opt in
+    u)
+      USERNAME_PREFIX="$OPTARG"
+      ;;
+    p)
+      USER_PASSWORD=$OPTARG
+      ;;
+    l)
+      LOCAL=$OPTARG
+      ;;
+    t)
+      TOTAL_USERS=$OPTARG
+      ;;
+    h)
+      help
+      ;;  
+    \?)
+      echo "Not valid option: -$OPTARG" >&2
+      help
+      ;;
+    :)
+      echo "The -$OPTARG option requires an argument." >&2
+      help
+      ;;
+  esac
+done
+
+if [[ "$USERNAME_PREFIX" == "" ]]
+then
+    echo "USERNAME_PREFIX must be set with option -u"
+    help
+    exit -1
+fi
+
+if [[ "$USER_PASSWORD" == "" ]]
+then
+    echo "USER_PASSWORD must be set with option -p"
+    help
+    exit -1
+fi
+
+# Other Stuff
+DOCKER_ROBOT_IMAGE=labs.etsi.org:5050/ocf/robot-tests-image
+DOCKER_ROBOT_IMAGE_VERSION=1.0
+cd ..
+REPOSITORY_BASE_FOLDER=${PWD}
+TEST_FOLDER=$REPOSITORY_BASE_FOLDER/tests
+RESULT_FOLDER=$REPOSITORY_BASE_FOLDER/results
+ROBOT_DOCKER_FILE_FOLDER=$REPOSITORY_BASE_FOLDER/tools/robot
+
+# nginx Hostname and http port (80 by default) to reach for tests
+CAPIF_REGISTER=capifcore
+CAPIF_REGISTER_PORT=8084
+CAPIF_HOSTNAME=capifcore
+CAPIF_HTTP_PORT=8080
+CAPIF_HTTPS_PORT=443
+
+# VAULT access configuration
+CAPIF_VAULT=vault
+CAPIF_VAULT_PORT=8200
+CAPIF_VAULT_TOKEN=read-ca-token
+
+# Mock Server
+MOCK_SERVER_URL=http://mock-server:9090
+NOTIFICATION_DESTINATION_URL=$MOCK_SERVER_URL
+
+# Show variables
+echo "CAPIF_HOSTNAME = $CAPIF_HOSTNAME"
+echo "CAPIF_REGISTER = $CAPIF_REGISTER"
+echo "CAPIF_HTTP_PORT = $CAPIF_HTTP_PORT"
+echo "CAPIF_HTTPS_PORT = $CAPIF_HTTPS_PORT"
+echo "CAPIF_VAULT = $CAPIF_VAULT"
+echo "CAPIF_VAULT_PORT = $CAPIF_VAULT_PORT"
+echo "CAPIF_VAULT_TOKEN = $CAPIF_VAULT_TOKEN"
+echo "TOTAL_USERS=$TOTAL_USERS"
+echo "USERNAME_PREFIX=$USERNAME_PREFIX"
+echo "USER_PASSWORD=$USER_PASSWORD"
+echo "MOCK_SERVER_URL=$MOCK_SERVER_URL"
+echo "NOTIFICATION_DESTINATION_URL=$NOTIFICATION_DESTINATION_URL"
+
+docker >/dev/null 2>/dev/null
+if [[ $? -ne 0 ]]
+then
+    echo "Docker maybe is not installed. Please check if docker CLI is present."
+    exit -1
+fi
+
+docker images|grep -Eq '^'$DOCKER_ROBOT_IMAGE'[ ]+[ ]'$DOCKER_ROBOT_IMAGE_VERSION''
+if [[ $? -ne 0 ]]
+then
+    read -p "Robot image is not present. To continue, Do you want to build it? (y/n)" build_robot_image
+    if [[ $build_robot_image == "y" ]]
+    then
+        echo "Building Robot docker image."
+        cd $ROBOT_DOCKER_FILE_FOLDER
+        docker build --no-cache -t $DOCKER_ROBOT_IMAGE:$DOCKER_ROBOT_IMAGE_VERSION .
+        cd $REPOSITORY_BASE_FOLDER
+    else
+        exit -2
+    fi
+fi
+
+mkdir -p $RESULT_FOLDER
+
+if [[ "$LOCAL" == "true" ]]
+then
+    docker run -ti --rm --network="host" \
+       --add-host host.docker.internal:host-gateway \
+       --add-host vault:host-gateway \
+       --add-host register:host-gateway \
+       --add-host mock-server:host-gateway \
+       -v $TEST_FOLDER:/opt/robot-tests/tests \
+       -v $RESULT_FOLDER:/opt/robot-tests/results ${DOCKER_ROBOT_IMAGE}:${DOCKER_ROBOT_IMAGE_VERSION}  \
+       --variable CAPIF_HOSTNAME:$CAPIF_HOSTNAME \
+       --variable CAPIF_HTTP_PORT:$CAPIF_HTTP_PORT \
+       --variable CAPIF_HTTPS_PORT:$CAPIF_HTTPS_PORT \
+       --variable CAPIF_REGISTER:$CAPIF_REGISTER \
+       --variable CAPIF_REGISTER_PORT:$CAPIF_REGISTER_PORT \
+       --variable CAPIF_VAULT:$CAPIF_VAULT \
+       --variable CAPIF_VAULT_PORT:$CAPIF_VAULT_PORT \
+       --variable CAPIF_VAULT_TOKEN:$CAPIF_VAULT_TOKEN \
+       --variable NOTIFICATION_DESTINATION_URL:$NOTIFICATION_DESTINATION_URL \
+       --variable MOCK_SERVER_URL:$MOCK_SERVER_URL \
+       --variable TOTAL_USERS:$TOTAL_USERS \
+       --variable USERNAME_PREFIX:$USERNAME_PREFIX \
+       --variable USER_PASSWORD:$USER_PASSWORD \
+       --include create-users
+else
+    docker run -ti --rm --network="host" \
+       -v $TEST_FOLDER:/opt/robot-tests/tests \
+       -v $RESULT_FOLDER:/opt/robot-tests/results ${DOCKER_ROBOT_IMAGE}:${DOCKER_ROBOT_IMAGE_VERSION}  \
+       --variable CAPIF_HOSTNAME:$CAPIF_HOSTNAME \
+       --variable CAPIF_HTTP_PORT:$CAPIF_HTTP_PORT \
+       --variable CAPIF_HTTPS_PORT:$CAPIF_HTTPS_PORT \
+       --variable CAPIF_REGISTER:$CAPIF_REGISTER \
+       --variable CAPIF_REGISTER_PORT:$CAPIF_REGISTER_PORT \
+       --variable CAPIF_VAULT:$CAPIF_VAULT \
+       --variable CAPIF_VAULT_PORT:$CAPIF_VAULT_PORT \
+       --variable CAPIF_VAULT_TOKEN:$CAPIF_VAULT_TOKEN \
+       --variable NOTIFICATION_DESTINATION_URL:$NOTIFICATION_DESTINATION_URL \
+       --variable MOCK_SERVER_URL:$MOCK_SERVER_URL \
+       --variable TOTAL_USERS:$TOTAL_USERS \
+       --variable USERNAME_PREFIX:$USERNAME_PREFIX \
+       --variable USER_PASSWORD:$USER_PASSWORD \
+       --include create-users
+fi
\ No newline at end of file

services/remove_users.sh

+#!/bin/bash
+LOCAL=true
+
+# User to remove
+USERNAME_PREFIX=
+
+help() {
+  echo "Usage: $1 <options>"
+  echo "       -u : User prefix to use"
+  echo "       -l : Local usage of script (default true)"
+  echo "       -h : show this help"
+  exit 1
+}
+
+# Read params
+while getopts ":u:p:l:t:h" opt; do
+  case $opt in
+    u)
+      USERNAME_PREFIX="$OPTARG"
+      ;;
+    l)
+      LOCAL=$OPTARG
+      ;;
+    h)
+      help
+      ;;  
+    \?)
+      echo "Not valid option: -$OPTARG" >&2
+      help
+      ;;
+    :)
+      echo "The -$OPTARG option requires an argument." >&2
+      help
+      ;;
+  esac
+done
+
+if [[ "$USERNAME_PREFIX" == "" ]]
+then
+    echo "USERNAME_PREFIX must be set with option -u"
+    help
+    exit -1
+fi
+
+# Other Stuff
+DOCKER_ROBOT_IMAGE=labs.etsi.org:5050/ocf/robot-tests-image
+DOCKER_ROBOT_IMAGE_VERSION=1.0
+cd ..
+REPOSITORY_BASE_FOLDER=${PWD}
+TEST_FOLDER=$REPOSITORY_BASE_FOLDER/tests
+RESULT_FOLDER=$REPOSITORY_BASE_FOLDER/results
+ROBOT_DOCKER_FILE_FOLDER=$REPOSITORY_BASE_FOLDER/tools/robot
+
+# nginx Hostname and http port (80 by default) to reach for tests
+CAPIF_REGISTER=capifcore
+CAPIF_REGISTER_PORT=8084
+CAPIF_HOSTNAME=capifcore
+CAPIF_HTTP_PORT=8080
+CAPIF_HTTPS_PORT=443
+
+# VAULT access configuration
+CAPIF_VAULT=vault
+CAPIF_VAULT_PORT=8200
+CAPIF_VAULT_TOKEN=read-ca-token
+
+# Mock Server
+MOCK_SERVER_URL=http://mock-server:9090
+NOTIFICATION_DESTINATION_URL=$MOCK_SERVER_URL
+
+# Show variables
+echo "CAPIF_HOSTNAME = $CAPIF_HOSTNAME"
+echo "CAPIF_REGISTER = $CAPIF_REGISTER"
+echo "CAPIF_HTTP_PORT = $CAPIF_HTTP_PORT"
+echo "CAPIF_HTTPS_PORT = $CAPIF_HTTPS_PORT"
+echo "CAPIF_VAULT = $CAPIF_VAULT"
+echo "CAPIF_VAULT_PORT = $CAPIF_VAULT_PORT"
+echo "CAPIF_VAULT_TOKEN = $CAPIF_VAULT_TOKEN"
+echo "TOTAL_USERS=$TOTAL_USERS"
+echo "USERNAME_PREFIX=$USERNAME_PREFIX"
+echo "USER_PASSWORD=$USER_PASSWORD"
+echo "MOCK_SERVER_URL=$MOCK_SERVER_URL"
+echo "NOTIFICATION_DESTINATION_URL=$NOTIFICATION_DESTINATION_URL"
+
+docker >/dev/null 2>/dev/null
+if [[ $? -ne 0 ]]
+then
+    echo "Docker maybe is not installed. Please check if docker CLI is present."
+    exit -1
+fi
+
+docker images|grep -Eq '^'$DOCKER_ROBOT_IMAGE'[ ]+[ ]'$DOCKER_ROBOT_IMAGE_VERSION''
+if [[ $? -ne 0 ]]
+then
+    read -p "Robot image is not present. To continue, Do you want to build it? (y/n)" build_robot_image
+    if [[ $build_robot_image == "y" ]]
+    then
+        echo "Building Robot docker image."
+        cd $ROBOT_DOCKER_FILE_FOLDER
+        docker build --no-cache -t $DOCKER_ROBOT_IMAGE:$DOCKER_ROBOT_IMAGE_VERSION .
+        cd $REPOSITORY_BASE_FOLDER
+    else
+        exit -2
+    fi
+fi
+
+mkdir -p $RESULT_FOLDER
+
+if [[ "$LOCAL" == "true" ]]
+then
+    docker run -ti --rm --network="host" \
+       --add-host host.docker.internal:host-gateway \
+       --add-host vault:host-gateway \
+       --add-host register:host-gateway \
+       --add-host mock-server:host-gateway \
+       -v $TEST_FOLDER:/opt/robot-tests/tests \
+       -v $RESULT_FOLDER:/opt/robot-tests/results ${DOCKER_ROBOT_IMAGE}:${DOCKER_ROBOT_IMAGE_VERSION}  \
+       --variable CAPIF_HOSTNAME:$CAPIF_HOSTNAME \
+       --variable CAPIF_HTTP_PORT:$CAPIF_HTTP_PORT \
+       --variable CAPIF_HTTPS_PORT:$CAPIF_HTTPS_PORT \
+       --variable CAPIF_REGISTER:$CAPIF_REGISTER \
+       --variable CAPIF_REGISTER_PORT:$CAPIF_REGISTER_PORT \
+       --variable CAPIF_VAULT:$CAPIF_VAULT \
+       --variable CAPIF_VAULT_PORT:$CAPIF_VAULT_PORT \
+       --variable CAPIF_VAULT_TOKEN:$CAPIF_VAULT_TOKEN \
+       --variable NOTIFICATION_DESTINATION_URL:$NOTIFICATION_DESTINATION_URL \
+       --variable MOCK_SERVER_URL:$MOCK_SERVER_URL \
+       --variable USERNAME_PREFIX:$USERNAME_PREFIX \
+       --include remove-users
+else
+    docker run -ti --rm --network="host" \
+       -v $TEST_FOLDER:/opt/robot-tests/tests \
+       -v $RESULT_FOLDER:/opt/robot-tests/results ${DOCKER_ROBOT_IMAGE}:${DOCKER_ROBOT_IMAGE_VERSION}  \
+       --variable CAPIF_HOSTNAME:$CAPIF_HOSTNAME \
+       --variable CAPIF_HTTP_PORT:$CAPIF_HTTP_PORT \
+       --variable CAPIF_HTTPS_PORT:$CAPIF_HTTPS_PORT \
+       --variable CAPIF_REGISTER:$CAPIF_REGISTER \
+       --variable CAPIF_REGISTER_PORT:$CAPIF_REGISTER_PORT \
+       --variable CAPIF_VAULT:$CAPIF_VAULT \
+       --variable CAPIF_VAULT_PORT:$CAPIF_VAULT_PORT \
+       --variable CAPIF_VAULT_TOKEN:$CAPIF_VAULT_TOKEN \
+       --variable NOTIFICATION_DESTINATION_URL:$NOTIFICATION_DESTINATION_URL \
+       --variable MOCK_SERVER_URL:$MOCK_SERVER_URL \
+       --variable USERNAME_PREFIX:$USERNAME_PREFIX \
+       --include remove-users
+fi
\ No newline at end of file

tests/libraries/helpers.py

@@ -152,3 +152,13 @@ def write_dictionary(file_path, data):
     with open(file_path, 'wb') as fp:
         pickle.dump(data, fp)
         print('dictionary saved successfully to file ' + file_path)
+
+def filter_users_by_prefix_username(users, prefix):
+    if prefix.strip() == "":
+        raise Exception('prefix value must contain some value')
+
+    filtered_users=list()
+    for user in users:
+        if user['username'].startswith(prefix):
+            filtered_users.append(user['username'])
+    return filtered_users

tests/tasks/Users Management/users.robot

@@ -88,3 +88,22 @@ Remove Client Users
 
     Log Many    ${result.stdout}
 
+
+Remove Client Users By Prefix
+    [Tags]    remove-users-by-prefix
+
+    ${users}=   Get List of Users At Register
+
+    ${users_to_remove}=   Filter Users By Prefix Username   users=${users}    prefix=${USERNAME_PREFIX}
+
+    Log Dictionary    ${users_to_remove}
+
+    FOR    ${username}    IN    @{users_to_remove}
+        Log    Removing ${username}
+        Run Keyword And Continue On Failure   Delete User At Register  username=${username}
+    END
+
+    ${result}=    Run Process    ls    -l
+
+    Log Many    ${result.stdout}
+