glpi-project/tools

A set of tools that can be used from core and from plugins

GLPI tools

A set of tools used in the core GLPI project and also from plugins.

Github Actions

Following Gihub Actions are available:

• Plugin package building.

tools's Issues

Bad release package when plugin name contains "s"

See : https://github.com/pluginsGLPI/useditemsexport/issues/28

Official plugin name is useditemsexport.

When using the release tool, the "s" is removed from the name (in package name and content) :

$ ./vendor/bin/plugin-release
Do you want to build version 2.0.0? [Yes/no] Yes
Building glpi-useditemexport-2.0.0...
Archiving GIT tag 2.0.0
Adding vendor libraries

Bad archive package name :

$ ls -la dist/
total 16332
drwxrwxr-x 2 francois francois     4096 mai   11 08:45 .
drwxr-xr-x 9 francois francois     4096 mai   11 08:45 ..
-rw-rw-r-- 1 francois francois 16707592 mai   11 08:45 glpi-useditemexport-2.0.0.tar.bz2
-rw-rw-r-- 1 francois francois      833 mai   11 08:45 glpi-useditemexport-2.0.0.tar.bz2.asc

Bad archive package content :

$ tar -jtvf dist/glpi-useditemexport-2.0.0.tar.bz2 
drwxrwxr-x francois/francois 0 2018-05-11 08:45 useditemexport/
drwxrwxr-x francois/francois 0 2018-02-20 15:05 useditemexport/screenshots/
-rw-rw-r-- francois/francois 64560 2018-02-20 15:05 useditemexport/screenshots/fr_useditemsexport-tab.png
-rw-rw-r-- francois/francois   348 2018-02-20 15:05 useditemexport/README.md
-rw-rw-r-- francois/francois  3501 2018-02-20 15:05 useditemexport/setup.php
-rw-rw-r-- francois/francois 18046 2018-02-20 15:05 useditemexport/LICENSE
-rw-rw-r-- francois/francois   263 2018-02-20 15:05 useditemexport/composer.json
drwxrwxr-x francois/francois     0 2018-02-20 15:05 useditemexport/locales/
-rw-rw-r-- francois/francois  1465 2018-05-11 08:45 useditemexport/locales/en_GB.mo
-rw-rw-r-- francois/francois  2440 2018-02-20 15:05 useditemexport/locales/fr_FR.po
[...]

CSS/JS Minifying

Tools relies on Robo features to provide JS and CSS files minification. Recently, has bug has been discovered in GLPI core, (see glpi-project/glpi#7393); so we can no longer use it.

I did not find anything suitabe in already used languages, nowadays, all JS minifiers seems to be written in Javascrit or Java.

Windows 10 Python 3.[WinError 2] The system cannot find the file specified

OS: Windows 10
python version: 3.9.11
glpi-project/tools tag: 0.4.5
plugin-release version: 1.0.5 (not helpful)

Note: plugin-release script version has not changed since glpi-project/tools tag 0.1.7. The plugin-release script version is still 1.0.5, despite numerous modifications to fix issues with python version compatibility.

All occurrences of subprocess.Popen in tools/plugin-release require additional argument shell=True otherwise we get the following error below on Windows with python 3.9.x.

Adding vendor libraries
Traceback (most recent call last):
  File "C:\Users\105061136\Documents\GitHub\ldapcomputers\vendor\glpi-project\tools\tools\plugin-release", line 754, in <module>
    main()
  File "C:\Users\105061136\Documents\GitHub\ldapcomputers\vendor\glpi-project\tools\tools\plugin-release", line 751, in main
    _do_build(repo, buildver)
  File "C:\Users\105061136\Documents\GitHub\ldapcomputers\vendor\glpi-project\tools\tools\plugin-release", line 320, in _do_build
    prepare(plugin_name, archive)
  File "C:\Users\105061136\Documents\GitHub\ldapcomputers\vendor\glpi-project\tools\tools\plugin-release", line 417, in prepare
    p1 = subprocess.Popen(
  File "C:\Users\105061136\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 951, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "C:\Users\105061136\AppData\Local\Programs\Python\Python39\lib\subprocess.py", line 1420, in _execute_child
    hp, ht, pid, tid = _winapi.CreateProcess(executable, args,
FileNotFoundError: [WinError 2] The system cannot find the file specified