plugin-ci-workflow.yml

# +-------------------------------------------------------------------------+
# | Copyright (C) 2004-2026 The Cacti Group                                 |
# |                                                                         |
# | This program is free software; you can redistribute it and/or           |
# | modify it under the terms of the GNU General Public License             |
# | as published by the Free Software Foundation; either version 2          |
# | of the License, or (at your option) any later version.                  |
# |                                                                         |
# | This program is distributed in the hope that it will be useful,         |
# | but WITHOUT ANY WARRANTY; without even the implied warranty of          |
# | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the           |
# | GNU General Public License for more details.                            |
# +-------------------------------------------------------------------------+
# | Cacti: The Complete RRDtool-based Graphing Solution                     |
# +-------------------------------------------------------------------------+
# | This code is designed, written, and maintained by the Cacti Group. See  |
# | about.php and/or the AUTHORS file for specific developer information.   |
# +-------------------------------------------------------------------------+
# | http://www.cacti.net/                                                   |
# +-------------------------------------------------------------------------+

name: Plugin Integration Tests

on:
  push:
    branches:
      - main
      - develop
  pull_request:
    branches:
      - main
      - develop

jobs:
  integration-test:
    runs-on: ${{ matrix.os }}
    
    strategy:
      fail-fast: false
      matrix:
        php: ['8.1', '8.2', '8.3']
        os: [ubuntu-latest]
    
    services:
      mysql:
        image: mysql:8.0
        env:
          MYSQL_ROOT_PASSWORD: cactiroot
          MYSQL_DATABASE: cacti
          MYSQL_USER: cactiuser
          MYSQL_PASSWORD: cactiuser
        ports:
          - 3306:3306
        options: >-
          --health-cmd="mysqladmin ping"
          --health-interval=10s
          --health-timeout=5s
          --health-retries=3
    
    name: PHP ${{ matrix.php }} Integration Test on ${{ matrix.os }}
    
    steps:
    - name: Checkout Cacti
      uses: actions/checkout@v4
      with:
        repository: Cacti/cacti
        path: cacti
    
    - name: Checkout Syslog Plugin
      uses: actions/checkout@v4
      with:
        path: cacti/plugins/syslog
    
    - name: Install PHP ${{ matrix.php }}
      uses: shivammathur/setup-php@v2
      with:
        php-version: ${{ matrix.php }}
        extensions: intl, mysql, gd, ldap, gmp, xml, curl, json, mbstring
        ini-values: "post_max_size=256M, max_execution_time=60, date.timezone=America/New_York"
    
    - name: Check PHP version
      run: php -v
    
    
    - name: Run apt-get update
      run: sudo apt-get update
    
    - name: Install System Dependencies
      run: sudo apt-get install -y apache2 snmp snmpd rrdtool fping libapache2-mod-php${{ matrix.php }}
    
    - name: Start SNMPD Agent and Test
      run: |
        sudo systemctl start snmpd
        sudo snmpwalk -c public -v2c -On localhost .1.3.6.1.2.1.1
    
    - name: Setup Permissions
      run: |
        sudo chown -R www-data:runner ${{ github.workspace }}/cacti
        sudo find ${{ github.workspace }}/cacti -type d -exec chmod 775 {} \;
        sudo find ${{ github.workspace }}/cacti -type f -exec chmod 664 {} \;
        sudo chmod +x ${{ github.workspace }}/cacti/cmd.php
        sudo chmod +x ${{ github.workspace }}/cacti/poller.php
    
    - name: Create MySQL Config
      run: |
        echo -e "[client]\nuser = root\npassword = cactiroot\nhost = 127.0.0.1\n" > ~/.my.cnf
        cat ~/.my.cnf
    
    - name: Initialize Cacti Database
      env:
        MYSQL_AUTH_USR: '--defaults-file=~/.my.cnf'
      run: |
        mysql $MYSQL_AUTH_USR -e 'CREATE DATABASE IF NOT EXISTS cacti;'
        mysql $MYSQL_AUTH_USR -e "CREATE USER IF NOT EXISTS 'cactiuser'@'localhost' IDENTIFIED BY 'cactiuser';"
        mysql $MYSQL_AUTH_USR -e "GRANT ALL PRIVILEGES ON cacti.* TO 'cactiuser'@'localhost';"
        mysql $MYSQL_AUTH_USR -e "GRANT SELECT ON mysql.time_zone_name TO 'cactiuser'@'localhost';"
        mysql $MYSQL_AUTH_USR -e "FLUSH PRIVILEGES;"
        mysql $MYSQL_AUTH_USR cacti < ${{ github.workspace }}/cacti/cacti.sql
        mysql $MYSQL_AUTH_USR -e "INSERT INTO settings (name, value) VALUES ('path_php_binary', '/usr/bin/php')" cacti
    
    - name: Validate composer files
      run: |
        cd ${{ github.workspace }}/cacti
        if [ -f composer.json ]; then
          composer validate --strict || true
        fi
    
    - name: Install Composer Dependencies
      run: |
        cd ${{ github.workspace }}/cacti
        if [ -f composer.json ]; then
          sudo composer install --prefer-dist --no-progress
        fi
    
    - name: Create Cacti config.php
      run: |
        cat ${{ github.workspace }}/cacti/include/config.php.dist | \
        sed -r "s/localhost/127.0.0.1/g" | \
        sed -r "s/'cacti'/'cacti'/g" | \
        sed -r "s/'cactiuser'/'cactiuser'/g" | \
        sed -r "s/'cactiuser'/'cactiuser'/g" > ${{ github.workspace }}/cacti/include/config.php
        sudo chmod 664 ${{ github.workspace }}/cacti/include/config.php
    
    - name: Create Syslog Plugin config.php
      run: |
        cp ${{ github.workspace }}/cacti/plugins/syslog/config.php.dist ${{ github.workspace }}/cacti/plugins/syslog/config.php
        sed -i "s/localhost/127.0.0.1/g" ${{ github.workspace }}/cacti/plugins/syslog/config.php
        sed -i "s/'cacti'/'cacti'/g" ${{ github.workspace }}/cacti/plugins/syslog/config.php
        sed -i "s/'cactiuser'/'cactiuser'/g" ${{ github.workspace }}/cacti/plugins/syslog/config.php
        sed -i 's/\/\/\$/\$/g' ${{ github.workspace }}/cacti/plugins/syslog/config.php
        sudo chmod 664 ${{ github.workspace }}/cacti/plugins/syslog/config.php
    
    - name: Configure Apache
      run: |
        cat << 'EOF' | sed 's#GITHUB_WORKSPACE#${{ github.workspace }}#g' > /tmp/cacti.conf
        <VirtualHost *:80>
          ServerAdmin webmaster@localhost
          DocumentRoot GITHUB_WORKSPACE/cacti
          
          <Directory GITHUB_WORKSPACE/cacti>
            Options Indexes FollowSymLinks
            AllowOverride All
            Require all granted
          </Directory>
          
          ErrorLog ${APACHE_LOG_DIR}/error.log
          CustomLog ${APACHE_LOG_DIR}/access.log combined
        </VirtualHost>
        EOF
        sudo cp /tmp/cacti.conf /etc/apache2/sites-available/000-default.conf
        sudo systemctl restart apache2
    
    - name: Install Cacti via CLI
      run: |
        cd ${{ github.workspace }}/cacti
        sudo php cli/install_cacti.php --accept-eula --install --force
    
    - name: Install Syslog Plugin
      run: |
        cd ${{ github.workspace }}/cacti
        sudo php cli/plugin_manage.php --plugin=syslog --install --enable
    
    - name: Check PHP Syntax for Plugin
      run: |
        cd ${{ github.workspace }}/cacti/plugins/syslog
        if find . -name '*.php' -exec php -l {} 2>&1 \; | grep -iv 'no syntax errors detected'; then
          echo "Syntax errors found!"
          exit 1
        fi
    
    
    - name: Run Cacti Poller
      run: |
        cd ${{ github.workspace }}/cacti
        sudo php poller.php --poller=1 --force --debug
        if ! grep -q "SYSTEM STATS" log/cacti.log; then
          echo "Cacti poller did not finish successfully"
          cat log/cacti.log
          exit 1
        fi
    
    - name: Populate Syslog Test Data
      run: |
        sudo chmod +x ${{ github.workspace }}/cacti/plugins/syslog/.github/workflows/populate_syslog_incoming.sh
        cd ${{ github.workspace }}/cacti/plugins/syslog/.github/workflows
        sudo ./populate_syslog_incoming.sh


    - name: force Syslog Plugin Poller
      run: |
        cd ${{ github.workspace }}/cacti
        sudo php plugins/syslog/syslog_process.php  --debug
        if ! grep -q "SYSTEM SYSLOG STATS" log/cacti.log; then
          echo "Syslog plugin poller did not finish successfully"
          cat log/cacti.log
          exit 1
        fi

    
    - name: View Cacti Logs
      if: always()
      run: |
        if [ -f ${{ github.workspace }}/cacti/log/cacti.log ]; then
          echo "=== Cacti Log ==="
          sudo cat ${{ github.workspace }}/cacti/log/cacti.log
        fi


    - name: Create PHPStan config
      run: |
        cd ${{ github.workspace }}/cacti/plugins/syslog
        cat > phpstan.neon << 'EOF'
        parameters:
          level: 5
          paths:
            - .
          excludePaths:
            - vendor/
            - locales/
          ignoreErrors:
            - '#has invalid return type the\.#'
          bootstrapFiles:
            - ../../include/global.php
        EOF
    
    - name: Install PHPStan
      run: |
        cd ${{ github.workspace }}/cacti/plugins/syslog
        composer require --dev phpstan/phpstan --with-all-dependencies || composer global require phpstan/phpstan
    
    - name: Run PHPStan Analysis
      run: |
        cd ${{ github.workspace }}/cacti/plugins/syslog
        if [ -f vendor/bin/phpstan ]; then
          vendor/bin/phpstan analyse --no-progress --error-format=github || true
        else
          phpstan analyse --no-progress --error-format=github || true
        fi
      continue-on-error: true