Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ENSITECH-74 #13

Merged
merged 4 commits into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .git_hooks/post-checkout/01-install-dependencies.sh
1 change: 1 addition & 0 deletions .git_hooks/post-merge/01-install-dependencies.sh
1 change: 1 addition & 0 deletions .git_hooks/pre-commit/01-lint-php.sh
1 change: 1 addition & 0 deletions .git_hooks/pre-commit/02-php-cs-fixer.sh
1 change: 1 addition & 0 deletions .git_hooks/pre-push/01-composer-validate.sh
1 change: 1 addition & 0 deletions .git_hooks/pre-push/02-phpstan.sh
1 change: 1 addition & 0 deletions .git_hooks/pre-push/03-test-code.sh
22 changes: 22 additions & 0 deletions .git_hooks/scripts/composer-validate.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
#!/bin/bash

# Validate composer.json before commit

ESC_SEQ="\x1b["
COL_RESET=$ESC_SEQ"39;49;00m"
COL_RED=$ESC_SEQ"0;31m"
COL_GREEN=$ESC_SEQ"0;32m"
COL_YELLOW=$ESC_SEQ"0;33m"

echo
printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"composer-validate\""

VALID=$(composer validate --strict --no-check-publish --no-check-all | grep "is valid")

if [ "$VALID" != "" ]; then
echo "Okay"
exit 0
else
printf "$COL_RED%s$COL_RESET\r\n" "Composer validate check failed."
exit 1
fi
18 changes: 18 additions & 0 deletions .git_hooks/scripts/install-dependencies.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
#!/bin/bash

# - 'composer update' if changed composer.json

ESC_SEQ="\x1b["
COL_RESET=$ESC_SEQ"39;49;00m"
COL_RED=$ESC_SEQ"0;31m"
COL_GREEN=$ESC_SEQ"0;32m"
COL_YELLOW=$ESC_SEQ"0;33m"

changed_files="$(git diff-tree -r --name-only --no-commit-id HEAD@{1} HEAD)"

check_run() {
echo "$changed_files" | grep -q "$1" && echo " * changes detected in $1" && echo " * running $2" && eval "$2"
}

check_run composer.json "composer update"
exit 0
45 changes: 45 additions & 0 deletions .git_hooks/scripts/lint-php.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
#!/bin/bash

# Lint all added php-files via 'php -l'

ROOT_DIR="$(pwd)/"
LIST=$(git diff-index --cached --name-only --diff-filter=ACMR HEAD | sed '/^templates/d')
ERRORS_BUFFER=""
ESC_SEQ="\x1b["
COL_RESET=$ESC_SEQ"39;49;00m"
COL_RED=$ESC_SEQ"0;31m"
COL_GREEN=$ESC_SEQ"0;32m"
COL_YELLOW=$ESC_SEQ"0;33m"
COL_BLUE=$ESC_SEQ"0;34m"
COL_MAGENTA=$ESC_SEQ"0;35m"
COL_CYAN=$ESC_SEQ"0;36m"

echo
printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-commit hook: \"php-linter\""

for file in $LIST
do
EXTENSION=$(echo "$file" | grep -E ".php$|.module$|.inc$|.install$")
if [ "$EXTENSION" != "" ]; then
ERRORS=$(php -l $ROOT_DIR$file 2>&1 | grep "Parse error")
if [ "$ERRORS" != "" ]; then
if [ "$ERRORS_BUFFER" != "" ]; then
ERRORS_BUFFER="$ERRORS_BUFFER\n$ERRORS"
else
ERRORS_BUFFER="$ERRORS"
fi
echo "Syntax errors found in file: $file "
fi
fi
done
if [ "$ERRORS_BUFFER" != "" ]; then
echo
echo "These errors were found in try-to-commit files: "
echo -e $ERRORS_BUFFER
echo
printf "$COL_RED%s$COL_RESET\r\n\r\n" "Can't commit, fix errors first."
exit 1
else
echo "Okay"
exit 0
fi
61 changes: 61 additions & 0 deletions .git_hooks/scripts/php-cs-fixer.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
#!/bin/bash

# Check code style via '.php-cs-fixer.php'

EXECUTABLE_NAME=php-cs-fixer
EXECUTABLE_COMMAND=fix
CONFIG_FILE=.php-cs-fixer.php
CONFIG_FILE_PARAMETER='--config'
ROOT=`pwd`
ESC_SEQ="\x1b["
COL_RESET=$ESC_SEQ"39;49;00m"
COL_RED=$ESC_SEQ"0;31m"
COL_GREEN=$ESC_SEQ"0;32m"
COL_YELLOW=$ESC_SEQ"0;33m"
COL_BLUE=$ESC_SEQ"0;34m"
COL_MAGENTA=$ESC_SEQ"0;35m"
COL_CYAN=$ESC_SEQ"0;36m"

echo ""
printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-commit hook: \"php-cs-fixer\""

# possible locations
locations=(
$ROOT/bin/$EXECUTABLE_NAME
$ROOT/vendor/bin/$EXECUTABLE_NAME
)

for location in ${locations[*]}
do
if [[ -x $location ]]; then
EXECUTABLE=$location
break
fi
done

if [[ ! -x $EXECUTABLE ]]; then
echo "executable $EXECUTABLE_NAME not found, exiting..."
echo "if you're sure this is incorrect, make sure they're executable (chmod +x)"
exit
fi

echo "using \"$EXECUTABLE_NAME\" located at $EXECUTABLE"
$EXECUTABLE --version

if [[ -f $ROOT/$CONFIG_FILE ]]; then
CONFIG=$ROOT/$CONFIG_FILE
echo "config file located at $CONFIG loaded"
fi

FILES=`git status --porcelain | grep -e '^[AM]\(.*\).php$' | cut -c 3- | sed -e "s/_ide_helper.php$//" | sed -e "s/_ide_helper_models.php$//" | sed -e "s/.phpstorm.meta.php$//" | tr '\n' ' ' | sed 's/ *$//g'`
if [ -z "$FILES" ]; then
echo "No php files found to fix."
else
echo "Fixing files ${FILES} in project";
if [[ -f $CONFIG ]]; then
$EXECUTABLE $EXECUTABLE_COMMAND $CONFIG_FILE_PARAMETER=$CONFIG ${FILES};
else
$EXECUTABLE $EXECUTABLE_COMMAND ${FILES};
fi
git add ${FILES}
fi
20 changes: 20 additions & 0 deletions .git_hooks/scripts/phpstan.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/bin/bash

# Run composer phpstan

ESC_SEQ="\x1b["
COL_RESET=$ESC_SEQ"39;49;00m"
COL_RED=$ESC_SEQ"0;31m"
COL_GREEN=$ESC_SEQ"0;32m"
COL_YELLOW=$ESC_SEQ"0;33m"

echo
printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"phpstan\""

if composer phpstan; then
echo "Okay"
exit 0
else
printf "$COL_RED%s$COL_RESET\r\n" "phpstan analysis failed."
exit 1
fi
20 changes: 20 additions & 0 deletions .git_hooks/scripts/test-code.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
#!/bin/bash

# Run composer test

ESC_SEQ="\x1b["
COL_RESET=$ESC_SEQ"39;49;00m"
COL_RED=$ESC_SEQ"0;31m"
COL_GREEN=$ESC_SEQ"0;32m"
COL_YELLOW=$ESC_SEQ"0;33m"

echo
printf "$COL_YELLOW%s$COL_RESET\n" "Running pre-push hook: \"test-code\""

if composer test; then
echo "Okay"
exit 0
else
printf "$COL_RED%s$COL_RESET\r\n" "Tests failed."
exit 1
fi
53 changes: 53 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Contributing

Contributions are **welcome** and will be fully **credited**.

Please read and understand the contribution guide before creating an issue or pull request.

## Etiquette

This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.

Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.

It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.

## Viability

When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.

## Procedure

Before filing an issue:

- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.

Before submitting a pull request:

- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.

## Requirements

If the project maintainer has any additional requirements, you will find them listed here.

- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.

- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.

- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.

- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.

**Happy coding**!
3 changes: 3 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Security Policy

If you discover any security related issues, please email [email protected] instead of using the issue tracker.
18 changes: 9 additions & 9 deletions .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ jobs:
matrix:
php: [8.1, 8.2, 8.3]
laravel: [9.*, 10.*, 11.*]
include:
- laravel: 9.*
testbench: 7.*
- laravel: 10.*
testbench: 8.*
- laravel: 11.*
testbench: 9.*
exclude:
- laravel: 11.*
php: 8.1
Expand All @@ -45,7 +38,14 @@ jobs:
echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
- name: Install dependencies
run: |
composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
composer require "laravel/framework:${{ matrix.laravel }}" --no-interaction --no-update
composer update --prefer-stable --prefer-dist --no-interaction

- name: Composer Validate
run: ./.git_hooks/scripts/composer-validate.sh

- name: Execute tests
run: vendor/bin/pest
run: composer test-ci

- name: Execute phpstan
run: ./.git_hooks/scripts/phpstan.sh
55 changes: 47 additions & 8 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,59 @@
# Project #
########################
.php_cs.cache
.php-cs-fixer.cache
.huskyrc
clients/*
!clients/.gitkeep
storage/ensi
generated
studio.json
build
/node_modules
/vendor
.phpunit.result.cache
composer.lock
composer.local.json
Homestead.json
Homestead.yaml
npm-debug.log
yarn-error.log
.php_cs.cache

# IDEs #
###################
*.sublime-project
*.sublime-workspace
/.idea/
/.idea
/.vscode
*.komodoproject
.vscode

# Static content #
###################
*.csv
*.pdf
*.doc
*.docx
*.xls
*.xlsx
*.xml
!phpunit.xml
!psalm.xml
*.yml
*.txt
*.wav
*.mp3
*.avi

# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so
*.box

# Packages #
############
Expand Down Expand Up @@ -38,9 +81,5 @@ yarn-error.log
.vagrant
ehthumbs.db
Thumbs.db

# tests
openapitools.json
.phpunit.result.cache
build
.php-cs-fixer.cache
sftp-config.json
auth.json
Loading
Loading