Merge pull request #10 from impresscms-dev/add-tests

MekDrop · web-flow · commit d19bdf65c9a9 · 2023-02-17T19:46:11.000+02:00
Add tests
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -7,3 +7,10 @@ updates:
       interval: monthly
     labels:
       - dependencies
+
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: monthly
+    labels:
+      - dependencies
diff --git a/.github/workflows/on-pull-request.yml b/.github/workflows/on-pull-request.yml
@@ -6,10 +6,37 @@ on:
       - main
 
 jobs:
-            
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php:
+          - 5.6
+
+    steps:
+      - name: Checkouting code...
+        uses: actions/checkout@v3
+
+      - name: Installing PHP...
+        uses: shivammathur/setup-php@2.24.0
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: curl, gd, json, mbstring, pcre, session
+          coverage: none
+          tools: composer:v2
+
+      - name: Setup BATS
+        uses: mig4/setup-bats@v1
+        with:
+          bats-version: 1.9.0
+
+      - name: Test
+        run: bats tests
+
   dependabot:
-#    needs: 
-#      - test
+    needs:
+      - test
     permissions:
       pull-requests: write
       contents: write
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 /.idea/
+/vendor/
+/composer.lock
diff --git a/action.yml b/action.yml
@@ -21,37 +21,33 @@ inputs:
 runs:
   using: 'composite'
   steps:
-    - name: Setting initial data...
-      run: |
-        mkdir -p "${{ inputs.output_path }}" || true
-        
-        GENERATOR_DOCS_PATH=$(php ${{ github.action_path }}/bin/realpath.php "${{ inputs.output_path }}")        
-        GENERATOR_TMP_FILES_PATH="${{ runner.temp }}/phpdocs-${{ github.sha }}-${{ github.run_id }}-${{ github.github.run_attempt }}"
-        
-        echo "GENERATOR_TMP_FILES_PATH=$GENERATOR_TMP_FILES_PATH" >> $GITHUB_ENV
-        echo "GENERATOR_DOCS_PATH=$GENERATOR_DOCS_PATH" >> $GITHUB_ENV
-        
-        rm -rf "$GENERATOR_TMP_FILES_PATH" || true
-        mkdir -p "$GENERATOR_TMP_FILES_PATH"
+    - name: Setting env variables...
+      env:
+        GENERATOR_TMP_FILES_PATH: "${{ runner.temp }}/phpdocs-${{ github.sha }}-${{ github.run_id }}-${{ github.github.run_attempt }}"
+        GENERATOR_DOCS_PATH: ${{ inputs.output_path }}
+      run: $ACTION_BIN_PATH/generate-env.sh "$GENERATOR_TMP_FILES_PATH" "$GENERATOR_DOCS_PATH" >> $GITHUB_ENV
+      shell: bash
+
+    - name: Creating required paths...
+      run: $ACTION_BIN_PATH/create-paths.sh
       shell: bash
 
     - name: Running phpDocumentator...
-      run: bash ${{ github.action_path }}/bin/phpdoc.sh "${{ inputs.ignored_files }}" "${{ inputs.phpdocumentor_version }}"
+      run: $ACTION_BIN_PATH/phpdoc.sh "${{ inputs.ignored_files }}" "${{ inputs.phpdocumentor_version }}"
       shell: bash
 
     - name: Installing evert/phpdoc-md...
-      run: composer global require 'evert/phpdoc-md=~0.2.0'
+      run: $ACTION_BIN_PATH/add-composer-packages.sh
       shell: bash
 
     - name: Generating documentation...
-      run: composer global exec phpdocmd "$GENERATOR_TMP_FILES_PATH/structure.xml" "$GENERATOR_DOCS_PATH"
+      run: $ACTION_BIN_PATH/generate-docs.sh
       shell: bash
 
     - name: Uninstalling evert/phpdoc-md...
-      run: composer global remove evert/phpdoc-md
+      run: $ACTION_BIN_PATH/remove-composer-dependencies.sh
       shell: bash
 
     - name: Deleting tmp data...
-      run: |
-        rm -rf "$GENERATOR_TMP_FILES_PATH" || true
+      run: $ACTION_BIN_PATH/remove-tmp-data.sh
       shell: bash
diff --git a/bin/add-composer-packages.sh b/bin/add-composer-packages.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+# shellcheck disable=SC2046
+composer global require $("$SCRIPT_DIR"/get-composer-dependencies.php)
diff --git a/bin/create-paths.sh b/bin/create-paths.sh
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+mkdir -p "$GENERATOR_DOCS_PATH" || true
+
+rm -rf "$GENERATOR_TMP_FILES_PATH" || true
+mkdir -p "$GENERATOR_TMP_FILES_PATH"
diff --git a/bin/generate-docs.sh b/bin/generate-docs.sh
@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+set -e
+
+composer global exec phpdocmd "$GENERATOR_TMP_FILES_PATH/structure.xml" "$GENERATOR_DOCS_PATH"
diff --git a/bin/generate-env.sh b/bin/generate-env.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+GENERATOR_TMP_FILES_PATH=$1
+GENERATOR_DOCS_PATH=$2
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+cat <<EOF
+GENERATOR_TMP_FILES_PATH=$("$SCRIPT_DIR/realpath.php" "$GENERATOR_TMP_FILES_PATH")
+GENERATOR_DOCS_PATH=$("$SCRIPT_DIR/realpath.php" "$GENERATOR_DOCS_PATH")
+ACTION_BIN_PATH=$SCRIPT_DIR
+EOF
diff --git a/bin/get-composer-dependencies.php b/bin/get-composer-dependencies.php
@@ -0,0 +1,18 @@
+#!/usr/bin/env php
+<?php
+
+$withVersions = !isset($argv[1]) || ((int)$argv[1] > 0);
+
+$contents = file_get_contents(dirname(__DIR__) . DIRECTORY_SEPARATOR . 'composer.json');
+$composer = json_decode($contents, true);
+
+$packages = [];
+foreach ($composer['require'] as $package => $version) {
+    if ($withVersions) {
+        $packages[] =  $package . "=" . $version;
+    } else {
+        $packages[] =  $package;
+    }
+}
+
+echo implode(" ", $packages);
diff --git a/bin/phpdoc.sh b/bin/phpdoc.sh
@@ -3,6 +3,7 @@
 IGNORED_FILES=$1
 PHPDOC_TAG=$2
 
+# shellcheck disable=SC2089
 GENERATOR_DOCKER_APP_ARGS="--target=/result --directory=/data --cache-folder=/tmp -v --template=xml --ansi --no-interaction --ignore=\"vendor/**\""
 if [ "$IGNORED_FILES" != "" ]; then
   while read -r line
@@ -11,6 +12,7 @@ if [ "$IGNORED_FILES" != "" ]; then
   done <<< "$IGNORED_FILES"
 fi;
 
+# shellcheck disable=SC2086 disable=SC1101 disable=SC2090
 docker run \
   --rm \
   -v ${PWD}:/data \
diff --git a/bin/realpath.php b/bin/realpath.php
@@ -1,3 +1,4 @@
+#!/usr/bin/env php
 <?php
 
 if (!isset($argv[1])) {
diff --git a/bin/remove-composer-dependencies.sh b/bin/remove-composer-dependencies.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -e
+
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+# shellcheck disable=SC2046
+composer global remove $("$SCRIPT_DIR"/get-composer-dependencies.php 0)
diff --git a/bin/remove-tmp-data.sh b/bin/remove-tmp-data.sh
@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+rm -rf "$GENERATOR_TMP_FILES_PATH" || true
diff --git a/composer.json b/composer.json
@@ -0,0 +1,15 @@
+{
+    "name": "impresscms-dev/generate-phpdocs-with-evert-phpdoc-md-action",
+    "description": "Libraries needed for same name GitHub action",
+    "type": "metapackage",
+    "require": {
+        "evert/phpdoc-md": "^0.2.0"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Raimondas Rimkevičius (aka MekDrop)",
+            "email": "github@mekdrop.name"
+        }
+    ]
+}
diff --git a/tests/01-realpath.bats b/tests/01-realpath.bats
@@ -0,0 +1,21 @@
+#!/usr/bin/env bats
+
+setup() {
+    export TMP_DATA_PATH=$(mktemp -d)
+    mkdir -p "$TMP_DATA_PATH/test"
+}
+
+tear() {
+    rm -rf "$TMP_DATA_PATH" || true
+}
+
+@test "realpath.php returns a directory" {
+    RET=$($BATS_TEST_DIRNAME/../bin/realpath.php "$TMP_DATA_PATH/test/../")
+    [ -d "$RET" ]
+}
+
+@test "realpath.php returns correct realpath" {
+    RET1=$($BATS_TEST_DIRNAME/../bin/realpath.php "$TMP_DATA_PATH/test/../")
+    RET2=$(realpath "$TMP_DATA_PATH/test/../")
+    [ "$RET1" == "$RET2" ]
+}
diff --git a/tests/02-generate-env.bats b/tests/02-generate-env.bats
@@ -0,0 +1,34 @@
+#!/usr/bin/env bats
+
+setup() {
+     export TMP_TEST_PATH_1=$(mktemp -d)
+     export TMP_TEST_PATH_2=$(mktemp -d)
+}
+
+tear() {
+    rm -rf "$TMP_TEST_PATH_1" || true
+    rm -rf "$TMP_TEST_PATH_2" || true
+}
+
+@test "GENERATOR_TMP_FILES_PATH var exists" {
+    eval $("$BATS_TEST_DIRNAME/../bin/generate-env.sh" "$TMP_TEST_PATH_1" "$TMP_TEST_PATH_2")
+    [ ! -z "$GENERATOR_TMP_FILES_PATH" ];
+}
+
+@test "GENERATOR_DOCS_PATH var exists" {
+    eval $("$BATS_TEST_DIRNAME/../bin/generate-env.sh" "$TMP_TEST_PATH_1" "$TMP_TEST_PATH_2")
+    [ ! -z "$GENERATOR_DOCS_PATH" ];
+}
+
+@test "ACTION_BIN_PATH var exists" {
+    eval $("$BATS_TEST_DIRNAME/../bin/generate-env.sh" "$TMP_TEST_PATH_1" "$TMP_TEST_PATH_2")
+    [ ! -z "$ACTION_BIN_PATH" ];
+}
+
+@test "ACTION_BIN_PATH is correct" {
+    eval $("$BATS_TEST_DIRNAME/../bin/generate-env.sh" "$TMP_TEST_PATH_1" "$TMP_TEST_PATH_2")
+    NORMALIZED_PATH_1=$(realpath "$ACTION_BIN_PATH")
+    NORMALIZED_PATH_2=$(realpath "$BATS_TEST_DIRNAME/../bin")
+
+    [ "$NORMALIZED_PATH_1" == "$NORMALIZED_PATH_2" ];
+}
diff --git a/tests/03-create-paths.bats b/tests/03-create-paths.bats
@@ -0,0 +1,21 @@
+#!/usr/bin/env bats
+
+setup_file() {
+    export TMP_DATA_PATH=$(mktemp -d)
+    export GENERATOR_DOCS_PATH=$TMP_DATA_PATH/docs
+    export GENERATOR_TMP_FILES_PATH=$TMP_DATA_PATH/files
+}
+
+tear_file() {
+    rm -rf "$TMP_DATA_PATH" || true
+}
+
+@test "GENERATOR_DOCS_PATH exists" {
+    "$BATS_TEST_DIRNAME/../bin/create-paths.sh"
+    [ -d "$GENERATOR_DOCS_PATH" ];
+}
+
+@test "GENERATOR_TMP_FILES_PATH exists" {
+    "$BATS_TEST_DIRNAME/../bin/create-paths.sh"
+    [ -d "$GENERATOR_TMP_FILES_PATH" ];
+}
diff --git a/tests/04-phpdocs.bats b/tests/04-phpdocs.bats
@@ -0,0 +1,41 @@
+#!/usr/bin/env bats
+
+setup() {
+     export TMP_TEST_PATH=$(mktemp -d)
+     export GENERATOR_TMP_FILES_PATH=$(mktemp -d)
+     export IGNORED_FILES=""
+     export PHPDOC_TAG=latest
+
+     pushd $TMP_TEST_PATH
+         git clone --quiet https://github.com/imponeer/toarray-interface.git .
+         git config --local advice.detachedHead false
+         git checkout 1.0.0
+     popd
+}
+
+tear() {
+    rm -rf "$TMP_TEST_PATH" || true
+    rm -rf "$GENERATOR_TMP_FILES_PATH" || true
+}
+
+@test "docker is available" {
+    command -v docker
+}
+
+@test "runs correctly" {
+    EXIT_CODE=0
+    pushd $TMP_TEST_PATH
+        "$BATS_TEST_DIRNAME/../bin/phpdoc.sh" "$IGNORED_FILES" "$PHPDOC_TAG"
+        EXIT_CODE=$?
+    popd
+
+    [ "$EXIT_CODE" == "0" ]
+}
+
+@test "produce some results" {
+    pushd $TMP_TEST_PATH
+        "$BATS_TEST_DIRNAME/../bin/phpdoc.sh" "$IGNORED_FILES" "$PHPDOC_TAG"
+    popd
+
+    [ -s "$GENERATOR_TMP_FILES_PATH" ]
+}
diff --git a/tests/05-get-composer-dependencies.bats b/tests/05-get-composer-dependencies.bats
@@ -0,0 +1,32 @@
+#!/usr/bin/env bats
+
+@test "composer.json exists" {
+    [ -f "$BATS_TEST_DIRNAME/../composer.json" ]
+}
+
+@test "get-composer-dependencies.php runs (without args)" {
+    $BATS_TEST_DIRNAME/../bin/get-composer-dependencies.php
+}
+
+@test "get-composer-dependencies.php returns output (without args)" {
+    RET=$($BATS_TEST_DIRNAME/../bin/get-composer-dependencies.php)
+    [ ! -z "$RET" ]
+}
+
+@test "get-composer-dependencies.php runs (with versions)" {
+    $BATS_TEST_DIRNAME/../bin/get-composer-dependencies.php 1
+}
+
+@test "get-composer-dependencies.php returns output (with versions)" {
+    RET=$($BATS_TEST_DIRNAME/../bin/get-composer-dependencies.php 1)
+    [ ! -z "$RET" ]
+}
+
+@test "get-composer-dependencies.php runs (without versions)" {
+    $BATS_TEST_DIRNAME/../bin/get-composer-dependencies.php 0
+}
+
+@test "get-composer-dependencies.php returns output (without versions)" {
+    RET=$($BATS_TEST_DIRNAME/../bin/get-composer-dependencies.php 0)
+    [ ! -z "$RET" ]
+}
diff --git a/tests/06-add-composer-packages.bats b/tests/06-add-composer-packages.bats
diff --git a/tests/07-generate-docs.bats b/tests/07-generate-docs.bats
diff --git a/tests/08-remove-composer-packages.bats b/tests/08-remove-composer-packages.bats
diff --git a/tests/09-remove-tmp-data.bats b/tests/09-remove-tmp-data.bats

Original file line number	Diff line number	Diff line change
`@@ -1 +1,3 @@`
`1`	`1`	`/.idea/`
	`2`	`+/vendor/`
	`3`	`+/composer.lock`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +#!/usr/bin/env bash
++
 +set -e
++
 +composer global exec phpdocmd "$GENERATOR_TMP_FILES_PATH/structure.xml" "$GENERATOR_DOCS_PATH"