OHRM5X-1537: Automation - Leave - Holidays

.github/workflows/cypress.yml

@@ -56,12 +56,14 @@ jobs:
 
       - name: Start docker containers
         run: |
+          sed -i '156s/volumes/tmpfs/' docker-compose.yml
+          sed -i '157s/mysql-data-55://' docker-compose.yml
           docker-compose up -d php-8.0 mysql55
           docker ps
 
       - name: Get yarn cache directory path
         id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
+        run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
 
       - uses: actions/cache@v3
         id: yarn-cache

.github/workflows/linting.yml

@@ -35,7 +35,7 @@ jobs:
         id: git-status
         run: |
           git status --porcelain
-          echo "::set-output name=status::$(git status --porcelain)"
+          echo "status=$(git status --porcelain)" >> $GITHUB_OUTPUT
 
       - name: Fail if files changed
         if: ${{ steps.git-status.outputs.status }}

.github/workflows/scheduled_test.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        database: [ 'mysql:5.5', 'mysql:5.6', 'mysql:5.7', 'mariadb:5.5', 'mariadb:10.0', 'mariadb:10.1', 'mariadb:10.2', 'mariadb:10.3', 'mariadb:10.4', 'mariadb:10.5', 'mariadb:10.6', 'mariadb:10.7', 'mariadb:10.8', 'mariadb:10.9' ]
+        database: [ 'mysql:5.5', 'mysql:5.6', 'mysql:5.7', 'mysql:8.0', 'mariadb:5.5', 'mariadb:10.0', 'mariadb:10.1', 'mariadb:10.2', 'mariadb:10.3', 'mariadb:10.4', 'mariadb:10.5', 'mariadb:10.6', 'mariadb:10.7', 'mariadb:10.8', 'mariadb:10.9' ]
 
     services:
       mysql:

.php-cs-fixer.dist.php

@@ -14,7 +14,6 @@
     // TODO:: Remove bellow excluded dirs, files
     ->exclude('devTools/load')
     ->exclude('lib')
-    ->exclude('src/plugins/orangehrmBuzzPlugin')
     ->exclude('src/plugins/orangehrmHelpPlugin/test')
     ->exclude('src/plugins/orangehrmMarketPlacePlugin')
     ->exclude('src/plugins/orangehrmOpenidAuthenticationPlugin')

README.md

@@ -1,8 +1,8 @@
-![](https://www.orangehrm.com/themes/orangehrm-modern/static/images/logo.png)
+<img width="40%" alt='OrangeHRM' src='https://raw.githubusercontent.com/wiki/orangehrm/orangehrm/logos/logo.svg#gh-light-mode-only'/><img width="40%" alt='OrangeHRM' src='https://raw.githubusercontent.com/wiki/orangehrm/orangehrm/logos/logo_dark_mode.svg#gh-dark-mode-only'/>
 
-[![Docker Pulls](https://img.shields.io/docker/pulls/orangehrm/orangehrm.svg)](https://hub.docker.com/r/orangehrm/orangehrm) [![SourceForge Downloads](https://img.shields.io/sourceforge/dm/orangehrm.svg)](https://sourceforge.net/projects/orangehrm/) [![SourceForge Downloads](https://img.shields.io/sourceforge/dt/orangehrm.svg)](https://sourceforge.net/projects/orangehrm/) [![codecov](https://codecov.io/gh/orangehrm/orangehrm/branch/develop/graph/badge.svg)](https://codecov.io/gh/orangehrm/develop)
+[![Docker Pulls](https://img.shields.io/docker/pulls/orangehrm/orangehrm.svg)](https://hub.docker.com/r/orangehrm/orangehrm) [![SourceForge Downloads](https://img.shields.io/sourceforge/dm/orangehrm.svg)](https://sourceforge.net/projects/orangehrm/) [![SourceForge Downloads](https://img.shields.io/sourceforge/dt/orangehrm.svg)](https://sourceforge.net/projects/orangehrm/)
 
-# OrangeHRM Open Source Application
+# OrangeHRM Starter Application
 
 OrangeHRM is a comprehensive Human Resource Management (HRM) System that captures all the essential functionalities required for any enterprise. Copyright (C) 2006 OrangeHRM Inc., http://www.orangehrm.com/
 
@@ -12,48 +12,42 @@ OrangeHRM is distributed in the hope that it will be useful, but WITHOUT ANY WAR
 
 ## Getting started
 
-- Install OrangeHRM using the web installer
-  https://github.com/orangehrm/orangehrm/wiki/Getting-started
+- Download the latest version of OrangeHRM Starter [here](https://sourceforge.net/projects/orangehrm/files/latest/download).
 
-- For further information on how to use the product please refer the Free User Guide available on http://orangehrm.com/
+- Prerequisites and environment set up for installing OrangeHRM Starter:
+  - [Install on Linux](https://starterhelp.orangehrm.com/hc/en-us/articles/6187572000540-Prerequisites-for-installing-OrangeHRM-Starter-in-Linux)
+  - [Install on Windows](https://starterhelp.orangehrm.com/hc/en-us/articles/6187576427804-Prerequisites-for-installing-OrangeHRM-Starter-in-Windows)
 
-- In case Installation difficulties there is a seperate Installation Guides also available from the same source. 
+- Install OrangeHRM using the web installer:
+  - [OrangeHRM Starter Installation Guide](https://starterhelp.orangehrm.com/hc/en-us/articles/5295915003666-OrangeHRM-Starter-Installation-Guide)
+  - [OrangeHRM Starter Upgrade Guide](https://starterhelp.orangehrm.com/hc/en-us/articles/6937346912402-OrangeHRM-Starter-Upgrade-Guide-For-5x-versions-)
 
-- For Apache/PHP/MySQL Installation issues please refer to the Environment Setup Guide
-
-- For OrangeHRM Installation issues please refer to the OrangeHRM Installation Guide
+- For further information on how to use the product please refer to the User Guides, Tutorial videos, and FAQs available on [Help Portal](https://starterhelp.orangehrm.com)
 
 ## OrangeHRM Mobile App
 
 <a href="https://play.google.com/store/apps/details?id=com.orangehrm.opensource" target="_blank">
 <img height="54" alt='Get it on Google Play'
-    src='https://raw.githubusercontent.com/wiki/orangehrm/orangehrm/mobile/play_store_cropped_en_US.png'/>
+    src='https://raw.githubusercontent.com/wiki/orangehrm/orangehrm/mobile/play_store_cropped_en_US_2022_08_04.png'/>
 </a>
 <a href="https://apps.apple.com/us/app/orangehrm/id1527247547" target="_blank">
-<img height="53" alt='Download on the App Store'
+<img height="54" alt='Download on the App Store'
     src='https://raw.githubusercontent.com/wiki/orangehrm/orangehrm/mobile/app_store_en_US.svg'/>
 </a>
 
-## Contribute
-
-https://github.com/orangehrm/orangehrm/wiki/How-to-Contribute
-
 ## Resources
 
-https://github.com/orangehrm/orangehrm/wiki/Resources
-
-## Demo
-Live demo is available at : https://opensource-demo.orangehrmlive.com/index.php/auth/login
+### Demo
+Live demo is available at : https://opensource-demo.orangehrmlive.com
 
-## Releases
+### Releases
 Sourceforge : https://sourceforge.net/p/orangehrm
 
-## Contribute
-https://github.com/orangehrm/orangehrm/wiki/How-to-Contribute
-
-
-## Website
+### Website
 https://www.orangehrm.com/
 
+## Help & Support
+Submit your help requests through [OrangeHRM Help Portal](https://starterhelp.orangehrm.com/hc/en-us/requests/new) or Email to [ossupport@orangehrm.com](mailto:ossupport@orangehrm.com)
+
 ## License 
 GNU General Public License

bin/console

@@ -56,14 +56,18 @@ new Framework($env, $debug); // initializing kernel
 
 $request = new Request();
 $pluginConfigs = Config::get('ohrm_plugin_configs');
-foreach (array_values($pluginConfigs) as $pluginConfig) {
-    require_once $pluginConfig['filepath'];
-    /** @var PluginConfigurationInterface $configClass */
-    $configClass = new $pluginConfig['classname']();
-    $configClass->initialize($request);
-    if ($configClass instanceof ConsoleConfigurationInterface) {
-        $configClass->registerCommands($console);
+try {
+    foreach (array_values($pluginConfigs) as $pluginConfig) {
+        require_once $pluginConfig['filepath'];
+        /** @var PluginConfigurationInterface $configClass */
+        $configClass = new $pluginConfig['classname']();
+        $configClass->initialize($request);
+        if ($configClass instanceof ConsoleConfigurationInterface) {
+            $configClass->registerCommands($console);
+        }
     }
+} catch (Throwable $e) {
+    echo("\n" . $e->getMessage() . "\n\n");
 }
 
 $console->run();

build/.gitignore

@@ -0,0 +1,2 @@
+index.html
+orangehrm-v2.json

build/build.xml

@@ -22,7 +22,7 @@
 -->
 <project name="OrangeHRM" basedir="." default="dist">
 
-  <property name="version" value="5.2"/>
+  <property name="version" value="5.3"/>
   <property name="package.name" value="orangehrm-${version}"/>
   <resolvepath propertyName="project.dir" file=".."/>
   <resolvepath propertyName="dist.dir" file="dist"/>
@@ -60,32 +60,18 @@
         <exclude name="build/build.xml"/>
         <exclude name="build/phing-latest.phar"/>
         <exclude name=".github/**"/>
-        <exclude name="INSTALL.html"/>
         <exclude name="Dockerfile"/>
         <exclude name="devTools/**"/>
         <exclude name="lib/confs/Conf.php"/>
         <exclude name="lib/confs/cryptokeys/key.ohrm"/>
         <exclude name="orangehrm-quick-start-guide.html"/>
         <exclude name="src/test/**"/>
+        <exclude name="src/plugins/**/test/**"/>
 
-        <exclude name="src/plugins/orangehrmAdminPlugin/lib/**"/>
         <exclude name="src/plugins/orangehrmAuthenticationPlugin/lib/**"/>
         <exclude name="src/plugins/orangehrmCoreOAuthPlugin/lib/**"/>
-        <exclude name="src/plugins/orangehrmCorePlugin/lib/**"/>
-        <exclude name="src/plugins/orangehrmPimPlugin/lib/**"/>
-
-        <exclude name="src/plugins/orangehrmAttendancePlugin/lib"/>
-        <exclude name="src/plugins/orangehrmBuzzPlugin/lib"/>
-        <exclude name="src/plugins/orangehrmCoreWebServicePlugin/**"/>
-        <exclude name="src/plugins/orangehrmCorporateBrandingPlugin/lib"/>
-        <exclude name="src/plugins/orangehrmCorporateDirectoryPlugin/lib"/>
-        <exclude name="src/plugins/orangehrmDashboardPlugin/lib"/>
-        <exclude name="src/plugins/orangehrmMaintenancePlugin/lib"/>
-        <exclude name="src/plugins/orangehrmMarketPlacePlugin/lib"/>
+        <exclude name="src/plugins/orangehrmMarketPlacePlugin/**"/>
         <exclude name="src/plugins/orangehrmOpenidAuthenticationPlugin/**"/>
-        <exclude name="src/plugins/orangehrmPerformancePlugin/lib"/>
-        <exclude name="src/plugins/orangehrmPerformanceTrackerPlugin/**"/>
-        <exclude name="src/plugins/orangehrmRecruitmentPlugin/lib"/>
         <exclude name="src/plugins/orangehrmRESTPlugin/**"/>
 
         <!-- 5.x related -->

devTools/core/console.php

@@ -40,6 +40,7 @@
 use OrangeHRM\DevTools\Command\AddRolePermissionCommand;
 use OrangeHRM\DevTools\Command\CreateTestDatabaseCommand;
 use OrangeHRM\DevTools\Command\EventDispatcherDebugCommand;
+use OrangeHRM\DevTools\Command\GenerateOpenApiDocCommand;
 use OrangeHRM\DevTools\Command\PHPFixCodingStandardsCommand;
 use OrangeHRM\DevTools\Command\ReInstallCommand;
 use OrangeHRM\DevTools\Command\ResetInstallationCommand;
@@ -59,6 +60,7 @@
 $application->add(new ReInstallCommand());
 $application->add(new CreateTestDatabaseCommand());
 $application->add(new RunMigrationClassCommand());
+$application->add(new GenerateOpenApiDocCommand());
 
 ServiceContainer::getContainer()->register(Services::DOCTRINE)
     ->setFactory([Doctrine::class, 'getEntityManager']);

devTools/core/src/Command/GenerateOpenApiDocCommand.php

@@ -0,0 +1,76 @@
+<?php
+/**
+ * OrangeHRM is a comprehensive Human Resource Management (HRM) System that captures
+ * all the essential functionalities required for any enterprise.
+ * Copyright (C) 2006 OrangeHRM Inc., http://www.orangehrm.com
+ *
+ * OrangeHRM 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.
+ *
+ * OrangeHRM 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.
+ *
+ * You should have received a copy of the GNU General Public License along with this program;
+ * if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA  02110-1301, USA
+ */
+
+namespace OrangeHRM\DevTools\Command;
+
+use OpenApi\Generator;
+use OrangeHRM\Config\Config;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+class GenerateOpenApiDocCommand extends Command
+{
+    protected static $defaultName = 'generate-open-api-doc';
+
+    /**
+     * @inheritDoc
+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $command = $this->getApplication()->find('php-cs-fix');
+        $input = new ArrayInput([]);
+        $command->run($input, $output);
+
+        $paths = [Config::get(Config::PLUGINS_DIR) . '/orangehrmCorePlugin/Controller/Rest/V2'];
+        foreach (Config::get(Config::PLUGIN_PATHS) as $pluginAbsPath) {
+            $pathToApiDir = realpath($pluginAbsPath . '/Api');
+            if ($pathToApiDir !== false) {
+                $paths[] = $pathToApiDir;
+            }
+        }
+        $openapi = Generator::scan($paths);
+        $buildDir = Config::get(Config::BASE_DIR) . '/build';
+        $filePath = $buildDir . '/orangehrm-v2.json';
+
+        $openApiDefinition = $openapi->toJson(
+            JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_INVALID_UTF8_IGNORE
+        );
+
+        file_put_contents($filePath, $openApiDefinition);
+        $io->success("File write to `$filePath`");
+
+        $swaggerUI = file_get_contents(__DIR__ . '/swagger.tpl.html');
+
+        $pos = strpos($openApiDefinition, '3.1.0'); // TODO::remove this
+        if ($pos !== false) {
+            $openApiDefinition = substr_replace($openApiDefinition, '3.0.3', $pos, strlen('3.1.0'));
+        }
+        $swaggerUI = str_replace('OPEN_API_DEFINITION', $openApiDefinition, $swaggerUI);
+        $uiFilePath = $buildDir . '/index.html';
+        file_put_contents($uiFilePath, $swaggerUI);
+
+        $io->success("File write to `$uiFilePath`");
+        return Command::SUCCESS;
+    }
+}

devTools/core/src/Command/ReInstallCommand.php

@@ -147,6 +147,15 @@ public function handle(
         }
 
         $io->success('Done');
+
+        define('ENVIRONMENT', 'test');
+        $testConf = Config::getConf(true);
+        $this->tryClosure(function () use ($testConf, $io) {
+            $sm = $this->getEntityManager()->getConnection()->createSchemaManager();
+            $sm->dropDatabase($testConf->getDbName());
+            $io->success('Dropped test database');
+        });
+
         return Command::SUCCESS;
     }
 

devTools/core/src/Command/ResetInstallationCommand.php

@@ -19,7 +19,6 @@
 
 namespace OrangeHRM\DevTools\Command;
 
-use Conf;
 use OrangeHRM\Config\Config;
 use OrangeHRM\Core\Traits\ORM\EntityManagerHelperTrait;
 use OrangeHRM\Core\Utility\KeyHandler;
@@ -28,6 +27,7 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use Symfony\Component\Filesystem\Filesystem;
+use Throwable;
 
 class ResetInstallationCommand extends Command
 {
@@ -55,22 +55,30 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         }
 
         $pathToConf = Config::get(Config::CONF_FILE_PATH);
-        require_once $pathToConf;
-        $conf = new Conf();
+        $conf = Config::getConf();
         $dbName = $conf->getDbName();
 
         $sm = $this->getEntityManager()->getConnection()->createSchemaManager();
         $sm->dropDatabase("`$dbName`");
         $io->note("Dropped database `$dbName`");
 
+        define('ENVIRONMENT', 'test');
+        $testConf = Config::getConf(true);
+
         $fs = new Filesystem();
         $fs->remove($pathToConf);
         $io->note("Deleted conf file `$pathToConf`");
 
-        $pathToKey = KeyHandler::getRealPathToKey();
+        $pathToKey = KeyHandler::getPathToKey();
         $fs->remove($pathToKey);
         $io->note("Deleted key.ohrm file `$pathToKey`");
 
+        try {
+            $sm->dropDatabase($testConf->getDbName());
+            $io->note('Dropped test database');
+        } catch (Throwable $e) {
+        }
+
         $io->success('Done');
         return Command::SUCCESS;
     }

devTools/core/src/Command/RunMigrationClassCommand.php

@@ -22,6 +22,7 @@
 use Doctrine\DBAL\Connection;
 use OrangeHRM\Config\Config;
 use OrangeHRM\Core\Traits\ORM\EntityManagerHelperTrait;
+use OrangeHRM\Installer\Framework\HttpKernel;
 use OrangeHRM\Installer\Util\ConfigHelper;
 use OrangeHRM\Installer\Util\V1\AbstractMigration;
 use Symfony\Component\Console\Command\Command;
@@ -64,6 +65,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $io->error("Invalid migration class `$migrationClass`");
             return Command::FAILURE;
         }
+        new HttpKernel('prod', false); // Initiate kernel
         class_alias($migrationClass, '\OrangeHRM\DevTools\Command\_Migration');
         $migration = new class ($this->getEntityManager()->getConnection()) extends _Migration {
             private Connection $connection;

devTools/core/src/Command/swagger.tpl.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta name="description" content="OrangeHRM"/>
+  <title>OrangeHRM</title>
+  <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@4.13.0/swagger-ui.css" />
+</head>
+<body>
+<div id="app"></div>
+<script src="https://unpkg.com/swagger-ui-dist@4.13.0/swagger-ui-bundle.js" crossorigin></script>
+<script src="https://unpkg.com/swagger-ui-dist@4.13.0/swagger-ui-standalone-preset.js" crossorigin></script>
+<script>
+  const spec = OPEN_API_DEFINITION;
+  window.onload = () => {
+    window.ui = SwaggerUIBundle({
+      spec: spec,
+      dom_id: '#app',
+    });
+  };
+</script>
+</body>
+</html>