CI/CD for All/5G_APIs project

# CI/CD:

#

# VALIDATION triggered by:

#  - any (branch commit)

#  

# GENERATION triggered by:

#  - merge request

#   

workflow:

  rules:

    - if: $CI_PIPELINE_SOURCE == "merge_request_event"

    - if: $CI_COMMIT_BRANCH && $CI_OPEN_MERGE_REQUESTS

      when: never

    - if: $CI_COMMIT_BRANCH

variables:

  LOGFILE_OPENAPI: "openapi-validation.log"

stages:

  - validation

  - generation

Validate OpenAPI:

  stage: validation

  before_script:

    - |

     curl "${CI_API_V4_URL}/projects/57/repository/files/all%2Fvalidate-all%2Esh/raw?ref=master" >> validate-all.sh

    - chmod +x validate-all.sh

  script:

    - echo 'Validate OpenAPI'

    - ./validate-all.sh $(pwd)

  artifacts:

    name: "$CI_JOB_NAME"

    paths:

      - ${LOGFILE_OPENAPI}

CR contribution:

  stage: generation

  when: on_success

  only:

    - merge_requests

  before_script:

    - |

     curl "${CI_API_V4_URL}/projects/57/repository/files/all%2Fgenerate_changemarks%2Esh/raw?ref=master" >> generate_changemarks.sh

    - chmod +x generate_changemarks.sh

    # - |

     # curl "${CI_API_V4_URL}/projects/57/repository/files/all%2Fall_delimiter_start%2Edocx/raw?ref=master" >> all_delimiter_start.docx

    # - |

     # curl "${CI_API_V4_URL}/projects/57/repository/files/all%2Fall_delimiter_end%2Edocx/raw?ref=master" >> all_delimiter_end.docx

  script:

    - echo 'CR contribution'

    - mkdir docs

    - ./generate_changemarks.sh ${CI_PROJECT_URL} ${CI_MERGE_REQUEST_PROJECT_ID} ${CI_MERGE_REQUEST_IID}

    #- ./generate_changemarks.sh ${CI_PROJECT_URL} ${CI_MERGE_REQUEST_PROJECT_ID} ${CI_MERGE_REQUEST_IID} all_delimiter_start.docx all_delimiter_end.docx

  artifacts:

    paths:

      - docs/

    expose_as: 'Word document contribution'

 No newline at end of file

#!/bin/bash

DOCKER_IMAGE=forge.3gpp.org:5050/tools/3gpp-scripts/forgelib:v2.0.0

echo "\n------ Checking for docker image --------"

docker pull "$DOCKER_IMAGE"

echo "------ Removing previous outputs --------"

rm **/*.docx

echo "------ Parsing repo URL --------"

HOST_URL=$(echo $1 | cut -d'/' -f 1-3)

PROJECT_NAME=$(echo $1 | cut -d'/' -f 5- | cut -d'.' -f 1)

echo "HOST URL:" $HOST_URL

echo "PROJECT NAME:" $PROJECT_NAME

echo "PROJECT ID:" $2

echo "MERGE IID:" $3

echo "\n------ Generating change marks --------"

docker container run --rm -v $(pwd):/tmp/ "$DOCKER_IMAGE" forgelib-changedocs -vv --outPath=/tmp/docs "$HOST_URL" "$2" "$PROJECT_NAME" "$3"

#docker container run --rm -v $(pwd):/tmp/ "$DOCKER_IMAGE" forgelib-changedocs -vv --combine --outPath=/tmp/docs --startdelimiter "/tmp/$4" --enddelimiter "/tmp/$5" "$HOST_URL" "$2" "$PROJECT_NAME" "$3"

exit 0

#!/bin/bash

# Copyright ETSI 2019-2021

# See: https://forge.etsi.org/etsi-forge-copyright-statement.txt

LOGFILE=openapi-validation.log

DOCKER_IMAGE=etsiforge/swagger-cli:4.0.3

echo -e "\n------ Switching to $1 folder --------"

cd $1

echo "------ Checking for previous logs ------"

if [ -f "$LOGFILE" ] ; then

    echo "Found previous log. Removing it"

    rm "$LOGFILE"

fi

if [ -x "$(command -v docker)" ] ; then

    RUN_IN_DOCKER=0

    echo "Using dockerized validator ($DOCKER_IMAGE)"

    docker pull "$DOCKER_IMAGE"

	#docker pull -q "$DOCKER_IMAGE" --> Pull quietly only from Ubuntu 20.04

else

    RUN_IN_DOCKER=1

    if [ ! -x "$(command -v swagger-cli)" ] ; then

        echo "Validator swagger-cli not found. Quitting."

        exit 1

    else

        echo "Using local validator ($(which swagger-cli))"

    fi

fi

function validate {

    echo -e "----  Validating $i:  "    

    if [ $RUN_IN_DOCKER == 0 ] ; then

	   bname=$(basename "$1")

       docker run --rm -v $(pwd):"/specs" $DOCKER_IMAGE swagger-cli validate "/specs/$bname"

    else

        swagger-cli validate "$1"

    fi

}

echo -e "\n------ Validating all YAML files (may takes several minutes) ------"

# If there are no YAML file, simply exit

ls | grep -q yaml

found_yaml=$?

if [ ! $found_yaml ] ; then 

    echo "-- No YAML files."

    exit 0

fi

fres=0

LOG=""

ERR=""

for i in *.yaml ;  do

    MSG=$(validate "$i" 2>&1)

    res=$?

    if [ ! $res == 0 ] ; then 

        ERR="$ERR$MSG\n"

    fi 

    LOG="$LOG$MSG\n"

    fres=$(($fres||$res))

done

echo -e "\n-- Final validator returns $fres." | tee -a $LOGFILE

if [ $fres == 0 ] ; then

   echo "No errors found, all files validate the OpenAPI definition. Below the complete log." | tee -a $LOGFILE

else

   echo "Some errors found, see below the details." | tee -a $LOGFILE

fi

if [ ! "$ERR" == "" ] ; then 

    echo -e "\n---- Errors detected ----" | tee -a $LOGFILE

    echo -e $ERR  | tee -a $LOGFILE

fi

echo -e "\n---- Complete log of validation ----" | tee -a $LOGFILE

echo -e $LOG | tee -a $LOGFILE

echo -e "\n------ Content of the folder ------" | tee -a $LOGFILE

ls | tee -a $LOGFILE

# Exit code needed for jenkins to know the verdict of the build

exit $fres