Compare commits
3 Commits
18.0
...
fd9b169925
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
fd9b169925 | ||
|
|
9897d7ebe8 | ||
|
|
8558f5b79f |
@@ -1,42 +0,0 @@
|
|||||||
#!/bin/bash
|
|
||||||
#
|
|
||||||
# Run the Python tests of the given Odoo modules.
|
|
||||||
#
|
|
||||||
# This script is meant to be executed *inside* an Elabore doodba image
|
|
||||||
# (docker.0k.io/mirror/odoo:rc_<version>-ELABORE-LIGHT), with a
|
|
||||||
# PostgreSQL service reachable at $PGHOST. The modules under test are
|
|
||||||
# read from the current working directory (the checked-out repository),
|
|
||||||
# which is prepended to the addons path so that the PR's code takes
|
|
||||||
# precedence over the modules already baked in the image.
|
|
||||||
#
|
|
||||||
# Usage: odoo-tests.sh <module1,module2,...>
|
|
||||||
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
modules="${1:?usage: odoo-tests.sh <module1,module2,...>}"
|
|
||||||
|
|
||||||
export PGHOST=postgres
|
|
||||||
export PGUSER=odoo
|
|
||||||
export PGPASSWORD=odoopassword
|
|
||||||
export PGDATABASE="test_$(basename "$PWD" | tr '.-' '__')"
|
|
||||||
export WITHOUT_DEMO=all
|
|
||||||
export DB_FILTER='.*'
|
|
||||||
|
|
||||||
# Generate /opt/odoo/auto/odoo.conf from the environment and wait for
|
|
||||||
# the database to accept connections.
|
|
||||||
/opt/odoo/common/entrypoint
|
|
||||||
|
|
||||||
# Odoo test-tags format: "/module1,/module2" (one leading slash).
|
|
||||||
tags="/$(echo "$modules" | tr ',' ',/')"
|
|
||||||
|
|
||||||
exec odoo \
|
|
||||||
--config=/opt/odoo/auto/odoo.conf \
|
|
||||||
--max-cron-threads=0 \
|
|
||||||
--limit-time-real=10000 \
|
|
||||||
--workers=0 \
|
|
||||||
--test-enable \
|
|
||||||
--stop-after-init \
|
|
||||||
--addons-path="$PWD,/opt/odoo/auto/addons" \
|
|
||||||
-d "$PGDATABASE" \
|
|
||||||
-i "$modules" \
|
|
||||||
--test-tags "$tags"
|
|
||||||
@@ -1,79 +0,0 @@
|
|||||||
name: tests
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- "18.0*"
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
test:
|
|
||||||
runs-on: odoo-ci
|
|
||||||
container:
|
|
||||||
image: docker.0k.io/mirror/odoo:rc_18.0-ELABORE-LIGHT
|
|
||||||
services:
|
|
||||||
postgres:
|
|
||||||
image: docker.0k.io/postgres:17.2.0-myc
|
|
||||||
env:
|
|
||||||
POSTGRES_USER: odoo
|
|
||||||
POSTGRES_PASSWORD: odoopassword
|
|
||||||
POSTGRES_DB: postgres
|
|
||||||
steps:
|
|
||||||
# The doodba image ships no Node.js, so actions/checkout@v4 cannot
|
|
||||||
# run here. The repository is private, so the job token is required.
|
|
||||||
- name: Checkout
|
|
||||||
env:
|
|
||||||
SECRET_GITEA_TOKEN: ${{ secrets.GITEA_TOKEN }}
|
|
||||||
SECRET_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: |
|
|
||||||
set -eu
|
|
||||||
token="${GITEA_TOKEN:-${GITHUB_TOKEN:-${SECRET_GITEA_TOKEN:-${SECRET_GITHUB_TOKEN:-}}}}"
|
|
||||||
if [ -z "$token" ]; then
|
|
||||||
echo "::error::No job token available to clone the repository"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
server="${GITHUB_SERVER_URL:-https://git.elabore.coop}"
|
|
||||||
repo="${GITHUB_REPOSITORY:?GITHUB_REPOSITORY is not set}"
|
|
||||||
ref="${GITHUB_REF:-${GITHUB_SHA:?neither GITHUB_REF nor GITHUB_SHA is set}}"
|
|
||||||
auth_url="$(printf '%s' "${server%/}/${repo}.git" |
|
|
||||||
sed -E "s#^https://#https://${token}@#")"
|
|
||||||
git init -q .
|
|
||||||
git config --global --add safe.directory "$PWD"
|
|
||||||
git remote add origin "$auth_url"
|
|
||||||
git fetch -q --depth=1 origin "$ref"
|
|
||||||
git checkout -q FETCH_HEAD
|
|
||||||
|
|
||||||
- name: Detect changed modules
|
|
||||||
id: changed
|
|
||||||
run: |
|
|
||||||
set -eu
|
|
||||||
if [ -n "${GITHUB_BASE_REF:-}" ]; then
|
|
||||||
git fetch -q --depth=1 origin "refs/heads/$GITHUB_BASE_REF"
|
|
||||||
base_rev="FETCH_HEAD"
|
|
||||||
scope="diff against $GITHUB_BASE_REF"
|
|
||||||
else
|
|
||||||
base_rev=""
|
|
||||||
scope="all installable modules (manual run)"
|
|
||||||
fi
|
|
||||||
if [ -n "$base_rev" ]; then
|
|
||||||
modules="$(
|
|
||||||
git diff --name-only "$base_rev" HEAD |
|
|
||||||
awk -F/ '{print $1}' | sort -u |
|
|
||||||
while read -r dir; do
|
|
||||||
[ -f "$dir/__manifest__.py" ] && echo "$dir"
|
|
||||||
done | paste -sd, -
|
|
||||||
)"
|
|
||||||
else
|
|
||||||
modules="$(
|
|
||||||
for dir in */; do
|
|
||||||
dir="${dir%/}"
|
|
||||||
[ -f "$dir/__manifest__.py" ] && echo "$dir"
|
|
||||||
done | paste -sd, -
|
|
||||||
)"
|
|
||||||
fi
|
|
||||||
echo "modules=$modules" >> "$GITHUB_OUTPUT"
|
|
||||||
echo "Modules to test ($scope): ${modules:-<none>}"
|
|
||||||
|
|
||||||
- name: Run Odoo tests
|
|
||||||
if: steps.changed.outputs.modules != ''
|
|
||||||
run: bash .gitea/scripts/odoo-tests.sh "${{ steps.changed.outputs.modules }}"
|
|
||||||
88
.gitignore
vendored
88
.gitignore
vendored
@@ -1,88 +0,0 @@
|
|||||||
# Byte-compiled / optimized / DLL files
|
|
||||||
__pycache__/
|
|
||||||
*.py[cod]
|
|
||||||
/.venv
|
|
||||||
/.pytest_cache
|
|
||||||
/.ruff_cache
|
|
||||||
|
|
||||||
# C extensions
|
|
||||||
*.so
|
|
||||||
|
|
||||||
# Distribution / packaging
|
|
||||||
.Python
|
|
||||||
env/
|
|
||||||
bin/
|
|
||||||
build/
|
|
||||||
develop-eggs/
|
|
||||||
dist/
|
|
||||||
eggs/
|
|
||||||
lib64/
|
|
||||||
parts/
|
|
||||||
sdist/
|
|
||||||
var/
|
|
||||||
*.egg-info/
|
|
||||||
.installed.cfg
|
|
||||||
*.egg
|
|
||||||
*.eggs
|
|
||||||
|
|
||||||
# Windows installers
|
|
||||||
*.msi
|
|
||||||
|
|
||||||
# Debian packages
|
|
||||||
*.deb
|
|
||||||
|
|
||||||
# Redhat packages
|
|
||||||
*.rpm
|
|
||||||
|
|
||||||
# MacOS packages
|
|
||||||
*.dmg
|
|
||||||
*.pkg
|
|
||||||
|
|
||||||
# Installer logs
|
|
||||||
pip-log.txt
|
|
||||||
pip-delete-this-directory.txt
|
|
||||||
|
|
||||||
# Unit test / coverage reports
|
|
||||||
htmlcov/
|
|
||||||
.tox/
|
|
||||||
.coverage
|
|
||||||
.cache
|
|
||||||
nosetests.xml
|
|
||||||
coverage.xml
|
|
||||||
|
|
||||||
# Translations
|
|
||||||
*.mo
|
|
||||||
|
|
||||||
# Pycharm
|
|
||||||
.idea
|
|
||||||
|
|
||||||
# Eclipse
|
|
||||||
.settings
|
|
||||||
|
|
||||||
# Visual Studio cache/options directory
|
|
||||||
.vs/
|
|
||||||
.vscode
|
|
||||||
|
|
||||||
# OSX Files
|
|
||||||
.DS_Store
|
|
||||||
|
|
||||||
# Django stuff:
|
|
||||||
*.log
|
|
||||||
|
|
||||||
# Mr Developer
|
|
||||||
.mr.developer.cfg
|
|
||||||
.project
|
|
||||||
.pydevproject
|
|
||||||
|
|
||||||
# Rope
|
|
||||||
.ropeproject
|
|
||||||
|
|
||||||
# Sphinx documentation
|
|
||||||
docs/_build/
|
|
||||||
|
|
||||||
# Backup files
|
|
||||||
*~
|
|
||||||
*.swp
|
|
||||||
|
|
||||||
# OCA rules
|
|
||||||
!static/lib/
|
|
||||||
@@ -22,7 +22,7 @@ exclude: |
|
|||||||
(LICENSE.*|COPYING.*)
|
(LICENSE.*|COPYING.*)
|
||||||
default_language_version:
|
default_language_version:
|
||||||
python: python3
|
python: python3
|
||||||
node: "22.9.0"
|
node: "16.17.0"
|
||||||
repos:
|
repos:
|
||||||
- repo: local
|
- repo: local
|
||||||
hooks:
|
hooks:
|
||||||
@@ -38,12 +38,8 @@ repos:
|
|||||||
entry: found a en.po file
|
entry: found a en.po file
|
||||||
language: fail
|
language: fail
|
||||||
files: '[a-zA-Z0-9_]*/i18n/en\.po$'
|
files: '[a-zA-Z0-9_]*/i18n/en\.po$'
|
||||||
- repo: https://github.com/sbidoul/whool
|
|
||||||
rev: v1.3
|
|
||||||
hooks:
|
|
||||||
- id: whool-init
|
|
||||||
- repo: https://github.com/oca/maintainer-tools
|
- repo: https://github.com/oca/maintainer-tools
|
||||||
rev: b89f767503be6ab2b11e4f50a7557cb20066e667
|
rev: f9b919b9868143135a9c9cb03021089cabba8223
|
||||||
hooks:
|
hooks:
|
||||||
# update the NOT INSTALLABLE ADDONS section above
|
# update the NOT INSTALLABLE ADDONS section above
|
||||||
- id: oca-update-pre-commit-excluded-addons
|
- id: oca-update-pre-commit-excluded-addons
|
||||||
@@ -56,10 +52,10 @@ repos:
|
|||||||
bash -c 'oca-gen-addon-readme --addons-dir=. --branch=$(git symbolic-ref
|
bash -c 'oca-gen-addon-readme --addons-dir=. --branch=$(git symbolic-ref
|
||||||
refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@")
|
refs/remotes/origin/HEAD | sed "s@^refs/remotes/origin/@@")
|
||||||
--repo-name=$(basename $(git rev-parse --show-toplevel)) --org-name="Elabore"
|
--repo-name=$(basename $(git rev-parse --show-toplevel)) --org-name="Elabore"
|
||||||
--if-source-changed --keep-source-digest --convert-fragments-to-markdown'
|
--if-source-changed --keep-source-digest'
|
||||||
- id: oca-gen-external-dependencies
|
|
||||||
- repo: https://github.com/OCA/odoo-pre-commit-hooks
|
- repo: https://github.com/OCA/odoo-pre-commit-hooks
|
||||||
rev: v0.0.33
|
rev: v0.1.4
|
||||||
hooks:
|
hooks:
|
||||||
- id: oca-checks-odoo-module
|
- id: oca-checks-odoo-module
|
||||||
- id: oca-checks-po
|
- id: oca-checks-po
|
||||||
@@ -78,8 +74,8 @@ repos:
|
|||||||
files: \.(css|htm|html|js|json|jsx|less|md|scss|toml|ts|xml|yaml|yml)$
|
files: \.(css|htm|html|js|json|jsx|less|md|scss|toml|ts|xml|yaml|yml)$
|
||||||
language: node
|
language: node
|
||||||
additional_dependencies:
|
additional_dependencies:
|
||||||
- "prettier@3.3.3"
|
- "prettier@2.7.1"
|
||||||
- "@prettier/plugin-xml@3.4.1"
|
- "@prettier/plugin-xml@2.2.0"
|
||||||
- repo: local
|
- repo: local
|
||||||
hooks:
|
hooks:
|
||||||
- id: eslint
|
- id: eslint
|
||||||
@@ -92,11 +88,10 @@ repos:
|
|||||||
types: [javascript]
|
types: [javascript]
|
||||||
language: node
|
language: node
|
||||||
additional_dependencies:
|
additional_dependencies:
|
||||||
- "eslint@9.12.0"
|
- "eslint@8.24.0"
|
||||||
- "eslint-plugin-jsdoc@50.3.1"
|
- "eslint-plugin-jsdoc@"
|
||||||
- "globals@16.0.0"
|
|
||||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
rev: v4.6.0
|
rev: v5.0.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: trailing-whitespace
|
- id: trailing-whitespace
|
||||||
# exclude autogenerated files
|
# exclude autogenerated files
|
||||||
@@ -117,8 +112,23 @@ repos:
|
|||||||
- id: check-xml
|
- id: check-xml
|
||||||
- id: mixed-line-ending
|
- id: mixed-line-ending
|
||||||
args: ["--fix=lf"]
|
args: ["--fix=lf"]
|
||||||
|
- repo: https://github.com/PyCQA/docformatter
|
||||||
|
rev: v1.7.7
|
||||||
|
hooks:
|
||||||
|
- id: docformatter
|
||||||
|
args: [
|
||||||
|
"--in-place", # modify the files
|
||||||
|
"--recursive", # run on all the files
|
||||||
|
"--wrap-summaries",
|
||||||
|
"88", # max length of 1st line
|
||||||
|
"--wrap-descriptions",
|
||||||
|
"88", # max length of other lines
|
||||||
|
"--pre-summary-newline", # new line before a long summary
|
||||||
|
"--make-summary-multi-line", # force summary on multilines
|
||||||
|
]
|
||||||
|
additional_dependencies: ["tomli"] # if Python <3.11
|
||||||
- repo: https://github.com/astral-sh/ruff-pre-commit
|
- repo: https://github.com/astral-sh/ruff-pre-commit
|
||||||
rev: v0.6.8
|
rev: v0.12.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: ruff
|
- id: ruff
|
||||||
args: [--fix, --exit-non-zero-on-fix]
|
args: [--fix, --exit-non-zero-on-fix]
|
||||||
|
|||||||
73
.pylintrc
73
.pylintrc
@@ -10,7 +10,7 @@ manifest-required-authors=Elabore
|
|||||||
manifest-required-keys=license
|
manifest-required-keys=license
|
||||||
manifest-deprecated-keys=description,active
|
manifest-deprecated-keys=description,active
|
||||||
license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3
|
license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3
|
||||||
valid-odoo-versions=18.0
|
valid-odoo-versions=16.0
|
||||||
|
|
||||||
[MESSAGES CONTROL]
|
[MESSAGES CONTROL]
|
||||||
disable=all
|
disable=all
|
||||||
@@ -25,25 +25,19 @@ disable=all
|
|||||||
enable=anomalous-backslash-in-string,
|
enable=anomalous-backslash-in-string,
|
||||||
api-one-deprecated,
|
api-one-deprecated,
|
||||||
api-one-multi-together,
|
api-one-multi-together,
|
||||||
|
assignment-from-none,
|
||||||
|
attribute-deprecated,
|
||||||
class-camelcase,
|
class-camelcase,
|
||||||
|
dangerous-default-value,
|
||||||
dangerous-view-replace-wo-priority,
|
dangerous-view-replace-wo-priority,
|
||||||
|
development-status-allowed,
|
||||||
duplicate-id-csv,
|
duplicate-id-csv,
|
||||||
|
duplicate-key,
|
||||||
duplicate-xml-fields,
|
duplicate-xml-fields,
|
||||||
duplicate-xml-record-id,
|
duplicate-xml-record-id,
|
||||||
eval-referenced,
|
eval-referenced,
|
||||||
incoherent-interpreter-exec-perm,
|
|
||||||
openerp-exception-warning,
|
|
||||||
redundant-modulename-xml,
|
|
||||||
relative-import,
|
|
||||||
rst-syntax-error,
|
|
||||||
wrong-tabs-instead-of-spaces,
|
|
||||||
xml-syntax-error,
|
|
||||||
assignment-from-none,
|
|
||||||
attribute-deprecated,
|
|
||||||
dangerous-default-value,
|
|
||||||
development-status-allowed,
|
|
||||||
duplicate-key,
|
|
||||||
eval-used,
|
eval-used,
|
||||||
|
incoherent-interpreter-exec-perm,
|
||||||
license-allowed,
|
license-allowed,
|
||||||
manifest-author-string,
|
manifest-author-string,
|
||||||
manifest-deprecated-key,
|
manifest-deprecated-key,
|
||||||
@@ -54,68 +48,73 @@ enable=anomalous-backslash-in-string,
|
|||||||
method-inverse,
|
method-inverse,
|
||||||
method-required-super,
|
method-required-super,
|
||||||
method-search,
|
method-search,
|
||||||
|
openerp-exception-warning,
|
||||||
pointless-statement,
|
pointless-statement,
|
||||||
pointless-string-statement,
|
pointless-string-statement,
|
||||||
print-used,
|
print-used,
|
||||||
redundant-keyword-arg,
|
redundant-keyword-arg,
|
||||||
|
redundant-modulename-xml,
|
||||||
reimported,
|
reimported,
|
||||||
|
relative-import,
|
||||||
return-in-init,
|
return-in-init,
|
||||||
|
rst-syntax-error,
|
||||||
sql-injection,
|
sql-injection,
|
||||||
too-few-format-args,
|
too-few-format-args,
|
||||||
translation-field,
|
translation-field,
|
||||||
translation-required,
|
translation-required,
|
||||||
unreachable,
|
unreachable,
|
||||||
use-vim-comment,
|
use-vim-comment,
|
||||||
|
wrong-tabs-instead-of-spaces,
|
||||||
|
xml-syntax-error,
|
||||||
|
attribute-string-redundant,
|
||||||
character-not-valid-in-resource-link,
|
character-not-valid-in-resource-link,
|
||||||
|
consider-merging-classes-inherited,
|
||||||
|
context-overridden,
|
||||||
create-user-wo-reset-password,
|
create-user-wo-reset-password,
|
||||||
dangerous-filter-wo-user,
|
dangerous-filter-wo-user,
|
||||||
dangerous-qweb-replace-wo-priority,
|
dangerous-qweb-replace-wo-priority,
|
||||||
deprecated-data-xml-node,
|
deprecated-data-xml-node,
|
||||||
deprecated-openerp-xml-node,
|
deprecated-openerp-xml-node,
|
||||||
duplicate-po-message-definition,
|
duplicate-po-message-definition,
|
||||||
file-not-used,
|
|
||||||
missing-newline-extrafiles,
|
|
||||||
old-api7-method-defined,
|
|
||||||
po-msgstr-variables,
|
|
||||||
po-syntax-error,
|
|
||||||
str-format-used,
|
|
||||||
unnecessary-utf8-coding-comment,
|
|
||||||
xml-attribute-translatable,
|
|
||||||
xml-deprecated-qweb-directive,
|
|
||||||
xml-deprecated-tree-attribute,
|
|
||||||
attribute-string-redundant,
|
|
||||||
consider-merging-classes-inherited,
|
|
||||||
context-overridden,
|
|
||||||
except-pass,
|
except-pass,
|
||||||
|
file-not-used,
|
||||||
invalid-commit,
|
invalid-commit,
|
||||||
manifest-maintainers-list,
|
manifest-maintainers-list,
|
||||||
|
missing-newline-extrafiles,
|
||||||
missing-readme,
|
missing-readme,
|
||||||
missing-return,
|
missing-return,
|
||||||
odoo-addons-relative-import,
|
odoo-addons-relative-import,
|
||||||
|
old-api7-method-defined,
|
||||||
|
po-msgstr-variables,
|
||||||
|
po-syntax-error,
|
||||||
renamed-field-parameter,
|
renamed-field-parameter,
|
||||||
resource-not-exist,
|
resource-not-exist,
|
||||||
|
str-format-used,
|
||||||
test-folder-imported,
|
test-folder-imported,
|
||||||
translation-contains-variable,
|
translation-contains-variable,
|
||||||
translation-positional-used,
|
translation-positional-used,
|
||||||
website-manifest-key-not-valid-uri,
|
|
||||||
external-request-timeout,
|
|
||||||
missing-manifest-dependency,
|
|
||||||
too-complex,,
|
|
||||||
create-user-wo-reset-password,
|
|
||||||
dangerous-filter-wo-user,
|
|
||||||
file-not-used,
|
|
||||||
missing-newline-extrafiles,
|
|
||||||
no-utf8-coding-comment,
|
|
||||||
old-api7-method-defined,
|
|
||||||
unnecessary-utf8-coding-comment,
|
unnecessary-utf8-coding-comment,
|
||||||
|
website-manifest-key-not-valid-uri,
|
||||||
|
xml-attribute-translatable,
|
||||||
|
xml-deprecated-qweb-directive,
|
||||||
|
xml-deprecated-tree-attribute,
|
||||||
|
external-request-timeout,
|
||||||
# messages that do not cause the lint step to fail
|
# messages that do not cause the lint step to fail
|
||||||
consider-merging-classes-inherited,
|
consider-merging-classes-inherited,
|
||||||
|
create-user-wo-reset-password,
|
||||||
|
dangerous-filter-wo-user,
|
||||||
deprecated-module,
|
deprecated-module,
|
||||||
|
file-not-used,
|
||||||
invalid-commit,
|
invalid-commit,
|
||||||
|
missing-manifest-dependency,
|
||||||
|
missing-newline-extrafiles,
|
||||||
missing-readme,
|
missing-readme,
|
||||||
|
no-utf8-coding-comment,
|
||||||
odoo-addons-relative-import,
|
odoo-addons-relative-import,
|
||||||
|
old-api7-method-defined,
|
||||||
redefined-builtin,
|
redefined-builtin,
|
||||||
manifest-external-assets
|
too-complex,
|
||||||
|
unnecessary-utf8-coding-comment
|
||||||
|
|
||||||
|
|
||||||
[REPORTS]
|
[REPORTS]
|
||||||
|
|||||||
@@ -9,7 +9,7 @@ manifest-required-authors=Elabore
|
|||||||
manifest-required-keys=license
|
manifest-required-keys=license
|
||||||
manifest-deprecated-keys=description,active
|
manifest-deprecated-keys=description,active
|
||||||
license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3
|
license-allowed=AGPL-3,GPL-2,GPL-2 or any later version,GPL-3,GPL-3 or any later version,LGPL-3
|
||||||
valid-odoo-versions=18.0
|
valid-odoo-versions=16.0
|
||||||
|
|
||||||
[MESSAGES CONTROL]
|
[MESSAGES CONTROL]
|
||||||
disable=all
|
disable=all
|
||||||
@@ -17,25 +17,19 @@ disable=all
|
|||||||
enable=anomalous-backslash-in-string,
|
enable=anomalous-backslash-in-string,
|
||||||
api-one-deprecated,
|
api-one-deprecated,
|
||||||
api-one-multi-together,
|
api-one-multi-together,
|
||||||
|
assignment-from-none,
|
||||||
|
attribute-deprecated,
|
||||||
class-camelcase,
|
class-camelcase,
|
||||||
|
dangerous-default-value,
|
||||||
dangerous-view-replace-wo-priority,
|
dangerous-view-replace-wo-priority,
|
||||||
|
development-status-allowed,
|
||||||
duplicate-id-csv,
|
duplicate-id-csv,
|
||||||
|
duplicate-key,
|
||||||
duplicate-xml-fields,
|
duplicate-xml-fields,
|
||||||
duplicate-xml-record-id,
|
duplicate-xml-record-id,
|
||||||
eval-referenced,
|
eval-referenced,
|
||||||
incoherent-interpreter-exec-perm,
|
|
||||||
openerp-exception-warning,
|
|
||||||
redundant-modulename-xml,
|
|
||||||
relative-import,
|
|
||||||
rst-syntax-error,
|
|
||||||
wrong-tabs-instead-of-spaces,
|
|
||||||
xml-syntax-error,
|
|
||||||
assignment-from-none,
|
|
||||||
attribute-deprecated,
|
|
||||||
dangerous-default-value,
|
|
||||||
development-status-allowed,
|
|
||||||
duplicate-key,
|
|
||||||
eval-used,
|
eval-used,
|
||||||
|
incoherent-interpreter-exec-perm,
|
||||||
license-allowed,
|
license-allowed,
|
||||||
manifest-author-string,
|
manifest-author-string,
|
||||||
manifest-deprecated-key,
|
manifest-deprecated-key,
|
||||||
@@ -46,50 +40,56 @@ enable=anomalous-backslash-in-string,
|
|||||||
method-inverse,
|
method-inverse,
|
||||||
method-required-super,
|
method-required-super,
|
||||||
method-search,
|
method-search,
|
||||||
|
openerp-exception-warning,
|
||||||
pointless-statement,
|
pointless-statement,
|
||||||
pointless-string-statement,
|
pointless-string-statement,
|
||||||
print-used,
|
print-used,
|
||||||
redundant-keyword-arg,
|
redundant-keyword-arg,
|
||||||
|
redundant-modulename-xml,
|
||||||
reimported,
|
reimported,
|
||||||
|
relative-import,
|
||||||
return-in-init,
|
return-in-init,
|
||||||
|
rst-syntax-error,
|
||||||
sql-injection,
|
sql-injection,
|
||||||
too-few-format-args,
|
too-few-format-args,
|
||||||
translation-field,
|
translation-field,
|
||||||
translation-required,
|
translation-required,
|
||||||
unreachable,
|
unreachable,
|
||||||
use-vim-comment,
|
use-vim-comment,
|
||||||
|
wrong-tabs-instead-of-spaces,
|
||||||
|
xml-syntax-error,
|
||||||
|
attribute-string-redundant,
|
||||||
character-not-valid-in-resource-link,
|
character-not-valid-in-resource-link,
|
||||||
|
consider-merging-classes-inherited,
|
||||||
|
context-overridden,
|
||||||
create-user-wo-reset-password,
|
create-user-wo-reset-password,
|
||||||
dangerous-filter-wo-user,
|
dangerous-filter-wo-user,
|
||||||
dangerous-qweb-replace-wo-priority,
|
dangerous-qweb-replace-wo-priority,
|
||||||
deprecated-data-xml-node,
|
deprecated-data-xml-node,
|
||||||
deprecated-openerp-xml-node,
|
deprecated-openerp-xml-node,
|
||||||
duplicate-po-message-definition,
|
duplicate-po-message-definition,
|
||||||
file-not-used,
|
|
||||||
missing-newline-extrafiles,
|
|
||||||
old-api7-method-defined,
|
|
||||||
po-msgstr-variables,
|
|
||||||
po-syntax-error,
|
|
||||||
str-format-used,
|
|
||||||
unnecessary-utf8-coding-comment,
|
|
||||||
xml-attribute-translatable,
|
|
||||||
xml-deprecated-qweb-directive,
|
|
||||||
xml-deprecated-tree-attribute,
|
|
||||||
attribute-string-redundant,
|
|
||||||
consider-merging-classes-inherited,
|
|
||||||
context-overridden,
|
|
||||||
except-pass,
|
except-pass,
|
||||||
|
file-not-used,
|
||||||
invalid-commit,
|
invalid-commit,
|
||||||
manifest-maintainers-list,
|
manifest-maintainers-list,
|
||||||
|
missing-newline-extrafiles,
|
||||||
missing-readme,
|
missing-readme,
|
||||||
missing-return,
|
missing-return,
|
||||||
odoo-addons-relative-import,
|
odoo-addons-relative-import,
|
||||||
|
old-api7-method-defined,
|
||||||
|
po-msgstr-variables,
|
||||||
|
po-syntax-error,
|
||||||
renamed-field-parameter,
|
renamed-field-parameter,
|
||||||
resource-not-exist,
|
resource-not-exist,
|
||||||
|
str-format-used,
|
||||||
test-folder-imported,
|
test-folder-imported,
|
||||||
translation-contains-variable,
|
translation-contains-variable,
|
||||||
translation-positional-used,
|
translation-positional-used,
|
||||||
|
unnecessary-utf8-coding-comment,
|
||||||
website-manifest-key-not-valid-uri,
|
website-manifest-key-not-valid-uri,
|
||||||
|
xml-attribute-translatable,
|
||||||
|
xml-deprecated-qweb-directive,
|
||||||
|
xml-deprecated-tree-attribute,
|
||||||
external-request-timeout
|
external-request-timeout
|
||||||
|
|
||||||
[REPORTS]
|
[REPORTS]
|
||||||
|
|||||||
@@ -1,205 +0,0 @@
|
|||||||
var globals = require('globals');
|
|
||||||
jsdoc = require("eslint-plugin-jsdoc");
|
|
||||||
|
|
||||||
const config = [{
|
|
||||||
plugins: {
|
|
||||||
jsdoc,
|
|
||||||
},
|
|
||||||
|
|
||||||
languageOptions: {
|
|
||||||
globals: {
|
|
||||||
_: "readonly",
|
|
||||||
$: "readonly",
|
|
||||||
fuzzy: "readonly",
|
|
||||||
jQuery: "readonly",
|
|
||||||
moment: "readonly",
|
|
||||||
odoo: "readonly",
|
|
||||||
openerp: "readonly",
|
|
||||||
owl: "readonly",
|
|
||||||
luxon: "readonly",
|
|
||||||
QUnit: "readonly",
|
|
||||||
...globals.browser,
|
|
||||||
},
|
|
||||||
|
|
||||||
ecmaVersion: 2024,
|
|
||||||
sourceType: "script",
|
|
||||||
},
|
|
||||||
|
|
||||||
rules: {
|
|
||||||
"accessor-pairs": "warn",
|
|
||||||
"array-callback-return": "warn",
|
|
||||||
"callback-return": "warn",
|
|
||||||
"capitalized-comments": ["warn", "always", {
|
|
||||||
ignoreConsecutiveComments: true,
|
|
||||||
ignoreInlineComments: true,
|
|
||||||
}],
|
|
||||||
complexity: ["warn", 15],
|
|
||||||
"constructor-super": "warn",
|
|
||||||
"dot-notation": "warn",
|
|
||||||
eqeqeq: "warn",
|
|
||||||
"global-require": "warn",
|
|
||||||
"handle-callback-err": "warn",
|
|
||||||
"id-blacklist": "warn",
|
|
||||||
"id-match": "warn",
|
|
||||||
"init-declarations": "error",
|
|
||||||
"max-depth": "warn",
|
|
||||||
"max-nested-callbacks": "warn",
|
|
||||||
"max-statements-per-line": "warn",
|
|
||||||
"no-alert": "warn",
|
|
||||||
"no-array-constructor": "warn",
|
|
||||||
"no-caller": "warn",
|
|
||||||
"no-case-declarations": "warn",
|
|
||||||
"no-class-assign": "warn",
|
|
||||||
"no-cond-assign": "error",
|
|
||||||
"no-const-assign": "error",
|
|
||||||
"no-constant-condition": "warn",
|
|
||||||
"no-control-regex": "warn",
|
|
||||||
"no-debugger": "error",
|
|
||||||
"no-delete-var": "warn",
|
|
||||||
"no-div-regex": "warn",
|
|
||||||
"no-dupe-args": "error",
|
|
||||||
"no-dupe-class-members": "error",
|
|
||||||
"no-dupe-keys": "error",
|
|
||||||
"no-duplicate-case": "error",
|
|
||||||
"no-duplicate-imports": "error",
|
|
||||||
"no-else-return": "warn",
|
|
||||||
"no-empty-character-class": "warn",
|
|
||||||
"no-empty-function": "error",
|
|
||||||
"no-empty-pattern": "error",
|
|
||||||
"no-empty": "warn",
|
|
||||||
"no-eq-null": "error",
|
|
||||||
"no-eval": "error",
|
|
||||||
"no-ex-assign": "error",
|
|
||||||
"no-extend-native": "warn",
|
|
||||||
"no-extra-bind": "warn",
|
|
||||||
"no-extra-boolean-cast": "warn",
|
|
||||||
"no-extra-label": "warn",
|
|
||||||
"no-fallthrough": "warn",
|
|
||||||
"no-func-assign": "error",
|
|
||||||
"no-global-assign": "error",
|
|
||||||
"no-implicit-coercion": ["warn", {
|
|
||||||
allow: ["~"],
|
|
||||||
}],
|
|
||||||
"no-implicit-globals": "warn",
|
|
||||||
"no-implied-eval": "warn",
|
|
||||||
"no-inline-comments": "warn",
|
|
||||||
"no-inner-declarations": "warn",
|
|
||||||
"no-invalid-regexp": "warn",
|
|
||||||
"no-irregular-whitespace": "warn",
|
|
||||||
"no-iterator": "warn",
|
|
||||||
"no-label-var": "warn",
|
|
||||||
"no-labels": "warn",
|
|
||||||
"no-lone-blocks": "warn",
|
|
||||||
"no-lonely-if": "error",
|
|
||||||
"no-mixed-requires": "error",
|
|
||||||
"no-multi-str": "warn",
|
|
||||||
"no-native-reassign": "error",
|
|
||||||
"no-negated-condition": "warn",
|
|
||||||
"no-negated-in-lhs": "error",
|
|
||||||
"no-new-func": "warn",
|
|
||||||
"no-new-object": "warn",
|
|
||||||
"no-new-require": "warn",
|
|
||||||
"no-new-symbol": "warn",
|
|
||||||
"no-new-wrappers": "warn",
|
|
||||||
"no-new": "warn",
|
|
||||||
"no-obj-calls": "warn",
|
|
||||||
"no-octal-escape": "warn",
|
|
||||||
"no-octal": "warn",
|
|
||||||
"no-param-reassign": "warn",
|
|
||||||
"no-path-concat": "warn",
|
|
||||||
"no-process-env": "warn",
|
|
||||||
"no-process-exit": "warn",
|
|
||||||
"no-proto": "warn",
|
|
||||||
"no-prototype-builtins": "warn",
|
|
||||||
"no-redeclare": "warn",
|
|
||||||
"no-regex-spaces": "warn",
|
|
||||||
"no-restricted-globals": "warn",
|
|
||||||
"no-restricted-imports": "warn",
|
|
||||||
"no-restricted-modules": "warn",
|
|
||||||
"no-restricted-syntax": "warn",
|
|
||||||
"no-return-assign": "error",
|
|
||||||
"no-script-url": "warn",
|
|
||||||
"no-self-assign": "warn",
|
|
||||||
"no-self-compare": "warn",
|
|
||||||
"no-sequences": "warn",
|
|
||||||
"no-shadow-restricted-names": "warn",
|
|
||||||
"no-shadow": "warn",
|
|
||||||
"no-sparse-arrays": "warn",
|
|
||||||
"no-sync": "warn",
|
|
||||||
"no-this-before-super": "warn",
|
|
||||||
"no-throw-literal": "warn",
|
|
||||||
"no-undef-init": "warn",
|
|
||||||
"no-undef": "error",
|
|
||||||
"no-unmodified-loop-condition": "warn",
|
|
||||||
"no-unneeded-ternary": "error",
|
|
||||||
"no-unreachable": "error",
|
|
||||||
"no-unsafe-finally": "error",
|
|
||||||
"no-unused-expressions": "error",
|
|
||||||
"no-unused-labels": "error",
|
|
||||||
"no-unused-vars": "error",
|
|
||||||
"no-use-before-define": "error",
|
|
||||||
"no-useless-call": "warn",
|
|
||||||
"no-useless-computed-key": "warn",
|
|
||||||
"no-useless-concat": "warn",
|
|
||||||
"no-useless-constructor": "warn",
|
|
||||||
"no-useless-escape": "warn",
|
|
||||||
"no-useless-rename": "warn",
|
|
||||||
"no-void": "warn",
|
|
||||||
"no-with": "warn",
|
|
||||||
"operator-assignment": ["error", "always"],
|
|
||||||
"prefer-const": "warn",
|
|
||||||
radix: "warn",
|
|
||||||
"require-yield": "warn",
|
|
||||||
"sort-imports": "warn",
|
|
||||||
"spaced-comment": ["error", "always"],
|
|
||||||
strict: ["error", "function"],
|
|
||||||
"use-isnan": "error",
|
|
||||||
|
|
||||||
"jsdoc/check-tag-names": "warn",
|
|
||||||
"jsdoc/check-types": "warn",
|
|
||||||
"jsdoc/require-param-description": "off",
|
|
||||||
"jsdoc/require-return": "off",
|
|
||||||
"jsdoc/require-return-description": "off",
|
|
||||||
"jsdoc/require-return-type": "off",
|
|
||||||
|
|
||||||
"valid-typeof": "warn",
|
|
||||||
yoda: "warn",
|
|
||||||
},
|
|
||||||
|
|
||||||
settings: {
|
|
||||||
jsdoc: {
|
|
||||||
tagNamePreference: {
|
|
||||||
arg: "param",
|
|
||||||
argument: "param",
|
|
||||||
augments: "extends",
|
|
||||||
constructor: "class",
|
|
||||||
exception: "throws",
|
|
||||||
func: "function",
|
|
||||||
method: "function",
|
|
||||||
prop: "property",
|
|
||||||
return: "returns",
|
|
||||||
virtual: "abstract",
|
|
||||||
yield: "yields",
|
|
||||||
},
|
|
||||||
preferredTypes: {
|
|
||||||
array: "Array",
|
|
||||||
bool: "Boolean",
|
|
||||||
boolean: "Boolean",
|
|
||||||
number: "Number",
|
|
||||||
object: "Object",
|
|
||||||
str: "String",
|
|
||||||
string: "String",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
},
|
|
||||||
|
|
||||||
}, {
|
|
||||||
files: ["**/*.esm.js", "**/*test.js"],
|
|
||||||
|
|
||||||
languageOptions: {
|
|
||||||
ecmaVersion: 2024,
|
|
||||||
sourceType: "module",
|
|
||||||
},
|
|
||||||
}];
|
|
||||||
|
|
||||||
module.exports = config
|
|
||||||
@@ -1,92 +0,0 @@
|
|||||||
============================================
|
|
||||||
maintenance_create_requests_from_project_task
|
|
||||||
============================================
|
|
||||||
|
|
||||||
This module allows the bulk creation of maintenance requests directly from a
|
|
||||||
project task. It is particularly useful when a task requires maintenance
|
|
||||||
actions on multiple equipment items simultaneously.
|
|
||||||
|
|
||||||
Key features:
|
|
||||||
|
|
||||||
- **Bulk creation**: Create multiple maintenance requests at once from a task
|
|
||||||
- **Equipment filtering**: Use domain filters to select target equipment
|
|
||||||
- **Smart defaults**: Pre-fills equipment from the task's project
|
|
||||||
- **Request tracking**: View all maintenance requests linked to a task
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
Use Odoo normal module installation procedure to install
|
|
||||||
`maintenance_create_requests_from_project_task`.
|
|
||||||
|
|
||||||
This module depends on:
|
|
||||||
- `maintenance`
|
|
||||||
- `maintenance_project`
|
|
||||||
- `project`
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
No specific configuration is required.
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Creating Maintenance Requests from a Task
|
|
||||||
|
|
||||||
1. Go to Project > Tasks
|
|
||||||
2. Open a task
|
|
||||||
3. In the action menu (or via the server action), click "Create maintenance requests"
|
|
||||||
4. A wizard opens with:
|
|
||||||
- **Task**: The source task (read-only)
|
|
||||||
- **Title**: The name for all created maintenance requests
|
|
||||||
- **Equipment Domain**: Filter to select which equipment to target
|
|
||||||
- By default, shows equipment linked to the task's project
|
|
||||||
- Use the domain builder to refine the selection
|
|
||||||
- **Technician**: Assign a technician to all requests
|
|
||||||
- **Maintenance Type**: Corrective or Preventive
|
|
||||||
- **Priority**: From Very Low to High
|
|
||||||
- **Duration**: Estimated duration in hours
|
|
||||||
- **Scheduled Date**: When the maintenance should occur
|
|
||||||
- **Description**: Details about the maintenance work
|
|
||||||
5. Click "Create"
|
|
||||||
6. All matching equipment will have a maintenance request created
|
|
||||||
7. You are redirected to the list of created requests
|
|
||||||
|
|
||||||
## Viewing Linked Maintenance Requests
|
|
||||||
|
|
||||||
On the task form:
|
|
||||||
- A smart button shows the count of open (not done) maintenance requests
|
|
||||||
- Click it to view all maintenance requests linked to this task
|
|
||||||
|
|
||||||
## Equipment Domain Examples
|
|
||||||
|
|
||||||
- All equipment in the project: `[('project_id', '=', project_id)]`
|
|
||||||
- Only servers: `[('category_id.name', '=', 'Server')]`
|
|
||||||
- Equipment needing backup: `[('backup_activated', '=', True)]`
|
|
||||||
- Combine conditions: `[('project_id', '=', project_id), ('category_id.name', '=', 'Server')]`
|
|
||||||
|
|
||||||
# Known issues / Roadmap
|
|
||||||
|
|
||||||
- Add template support for common maintenance scenarios
|
|
||||||
- Add option to create a single request for multiple equipment
|
|
||||||
|
|
||||||
# Bug Tracker
|
|
||||||
|
|
||||||
Bugs are tracked on
|
|
||||||
[our issues website](https://git.elabore.coop/Elabore/maintenance-tools/issues). In
|
|
||||||
case of trouble, please check there if your issue has already been reported. If you
|
|
||||||
spotted it first, help us smashing it by providing a detailed and welcomed feedback.
|
|
||||||
|
|
||||||
# Credits
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
- Stéphan Sainléger
|
|
||||||
|
|
||||||
## Funders
|
|
||||||
|
|
||||||
The development of this module has been financially supported by:
|
|
||||||
|
|
||||||
- Elabore (https://elabore.coop)
|
|
||||||
|
|
||||||
## Maintainer
|
|
||||||
|
|
||||||
This module is maintained by Elabore.
|
|
||||||
@@ -1,89 +0,0 @@
|
|||||||
=======================
|
|
||||||
maintenance_server_data
|
|
||||||
=======================
|
|
||||||
|
|
||||||
This module extends the maintenance equipment model to store detailed server
|
|
||||||
information, enabling comprehensive server infrastructure management within Odoo.
|
|
||||||
|
|
||||||
It adds several new models and fields to track:
|
|
||||||
|
|
||||||
- **Server specifications**: IP address, CPU cores, RAM, disk storage
|
|
||||||
- **Operating system**: Distribution name and version
|
|
||||||
- **Services**: Track services running on each server with their versions and URLs
|
|
||||||
- **Backup information**: Backup server, activation status, and health
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
Use Odoo normal module installation procedure to install
|
|
||||||
`maintenance_server_data`.
|
|
||||||
|
|
||||||
This module depends on `maintenance`.
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
No specific configuration is required. After installation, new fields will be
|
|
||||||
available on the maintenance equipment form.
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Managing Server Equipment
|
|
||||||
|
|
||||||
1. Go to Maintenance > Equipments
|
|
||||||
2. Create or edit an equipment record
|
|
||||||
3. Fill in the server-specific fields:
|
|
||||||
- **Server IP Address**: The server's IP address
|
|
||||||
- **Distribution**: Select or create an OS distribution
|
|
||||||
- **Hosting City**: Physical location of the server
|
|
||||||
- **Nb Cores**: Number of CPU cores
|
|
||||||
- **RAM (Go)**: Amount of RAM in gigabytes
|
|
||||||
- **Disk Storage (Go)**: Disk capacity in gigabytes
|
|
||||||
- **Backup Activated**: Whether backups are enabled
|
|
||||||
- **Backup Server**: The backup destination server
|
|
||||||
- **Backup OK**: Current backup health status
|
|
||||||
|
|
||||||
## Managing OS Distributions
|
|
||||||
|
|
||||||
1. Go to Maintenance > Configuration > OS Distributions
|
|
||||||
2. Create distributions with name and version (e.g., "Ubuntu", "22.04")
|
|
||||||
3. The display name is automatically computed from name + version
|
|
||||||
|
|
||||||
## Managing Services
|
|
||||||
|
|
||||||
1. Go to Maintenance > Configuration > Services
|
|
||||||
2. Create service definitions (e.g., "PostgreSQL", "Nginx", "Odoo")
|
|
||||||
3. Create service versions for each service
|
|
||||||
4. Mark the latest version with "Is Last Version?"
|
|
||||||
|
|
||||||
## Managing Service Instances
|
|
||||||
|
|
||||||
1. Go to Maintenance > Configuration > Service Instances
|
|
||||||
2. Link services to equipment with their specific version and URL
|
|
||||||
3. Service instances are automatically archived when their equipment is archived
|
|
||||||
|
|
||||||
# Known issues / Roadmap
|
|
||||||
|
|
||||||
- Add monitoring integration for automated backup status checks
|
|
||||||
- Add service version upgrade tracking
|
|
||||||
|
|
||||||
# Bug Tracker
|
|
||||||
|
|
||||||
Bugs are tracked on
|
|
||||||
[our issues website](https://github.com/elabore-coop/maintenance-tools/issues). In
|
|
||||||
case of trouble, please check there if your issue has already been reported. If you
|
|
||||||
spotted it first, help us smashing it by providing a detailed and welcomed feedback.
|
|
||||||
|
|
||||||
# Credits
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
- Stéphan Sainléger
|
|
||||||
|
|
||||||
## Funders
|
|
||||||
|
|
||||||
The development of this module has been financially supported by:
|
|
||||||
|
|
||||||
- Elabore (https://elabore.coop)
|
|
||||||
|
|
||||||
## Maintainer
|
|
||||||
|
|
||||||
This module is maintained by Elabore.
|
|
||||||
@@ -4,14 +4,7 @@ from odoo import api, fields, models
|
|||||||
class MaintenanceEquipment(models.Model):
|
class MaintenanceEquipment(models.Model):
|
||||||
_inherit = "maintenance.equipment"
|
_inherit = "maintenance.equipment"
|
||||||
|
|
||||||
_sql_constraints = [
|
|
||||||
('unique_name', 'UNIQUE(name)', 'Name must be unique.'),
|
|
||||||
('unique_server_ip', 'UNIQUE(server_ip)', 'Server IP must be unique.'),
|
|
||||||
('unique_ssh_target', 'UNIQUE(ssh_target)', 'Main Domain Name must be unique.'),
|
|
||||||
]
|
|
||||||
|
|
||||||
server_ip = fields.Char("Server Ip Address")
|
server_ip = fields.Char("Server Ip Address")
|
||||||
ssh_target = fields.Char("SSH Target", )
|
|
||||||
distribution_id = fields.Many2one("os.distribution", string="Distribution")
|
distribution_id = fields.Many2one("os.distribution", string="Distribution")
|
||||||
service_ids = fields.One2many("service.instance", "equipment_id", string="Services")
|
service_ids = fields.One2many("service.instance", "equipment_id", string="Services")
|
||||||
hosting_city = fields.Char("Hosting City")
|
hosting_city = fields.Char("Hosting City")
|
||||||
@@ -24,24 +17,8 @@ class MaintenanceEquipment(models.Model):
|
|||||||
|
|
||||||
name_fr = fields.Char("Name (FR)", compute="_compute_name_fr", store=True)
|
name_fr = fields.Char("Name (FR)", compute="_compute_name_fr", store=True)
|
||||||
|
|
||||||
def copy_data(self, default=None):
|
|
||||||
default = dict(default or {})
|
|
||||||
if "server_ip" not in default:
|
|
||||||
default["server_ip"] = False
|
|
||||||
if "ssh_target" not in default:
|
|
||||||
default["ssh_target"] = False
|
|
||||||
vals_list = super().copy_data(default=default)
|
|
||||||
if "name" not in default:
|
|
||||||
for equipment, vals in zip(self, vals_list):
|
|
||||||
vals["name"] = self.env._("%s (copy)", equipment.name)
|
|
||||||
return vals_list
|
|
||||||
|
|
||||||
@api.depends("name")
|
@api.depends("name")
|
||||||
def _compute_name_fr(self):
|
def _compute_name_fr(self):
|
||||||
if not self.env["res.lang"]._lang_get("fr_FR"):
|
|
||||||
for record in self:
|
|
||||||
record.name_fr = record.name
|
|
||||||
return
|
|
||||||
for record in self:
|
for record in self:
|
||||||
record.name_fr = record.with_context(lang="fr_FR").name
|
record.name_fr = record.with_context(lang="fr_FR").name
|
||||||
|
|
||||||
|
|||||||
@@ -8,7 +8,6 @@
|
|||||||
<xpath expr="//field[@name='effective_date']/.." position="after">
|
<xpath expr="//field[@name='effective_date']/.." position="after">
|
||||||
<group name="server_data" string="Server data">
|
<group name="server_data" string="Server data">
|
||||||
<field name="server_ip" />
|
<field name="server_ip" />
|
||||||
<field name="ssh_target" />
|
|
||||||
<field name="hosting_city" />
|
<field name="hosting_city" />
|
||||||
<field name="distribution_id" />
|
<field name="distribution_id" />
|
||||||
<field name="nb_cores" />
|
<field name="nb_cores" />
|
||||||
@@ -46,7 +45,6 @@
|
|||||||
<field name="arch" type="xml">
|
<field name="arch" type="xml">
|
||||||
<xpath expr="//field[@name='category_id']" position="after">
|
<xpath expr="//field[@name='category_id']" position="after">
|
||||||
<field name="server_ip" optional="hide" />
|
<field name="server_ip" optional="hide" />
|
||||||
<field name="ssh_target" optional="hide" />
|
|
||||||
<field name="hosting_city" optional="hide" />
|
<field name="hosting_city" optional="hide" />
|
||||||
<field name="distribution_id" optional="hide" />
|
<field name="distribution_id" optional="hide" />
|
||||||
<field name="nb_cores" optional="hide" />
|
<field name="nb_cores" optional="hide" />
|
||||||
|
|||||||
@@ -1,2 +0,0 @@
|
|||||||
*.*~
|
|
||||||
*pyc
|
|
||||||
@@ -1,171 +0,0 @@
|
|||||||
===================================
|
|
||||||
maintenance_service_http_monitoring
|
|
||||||
===================================
|
|
||||||
|
|
||||||
This module provides automated HTTP availability monitoring for services
|
|
||||||
defined on maintenance equipment. It periodically checks the HTTP status of
|
|
||||||
service URLs and automatically creates maintenance requests when services
|
|
||||||
are detected as unavailable.
|
|
||||||
|
|
||||||
Key features:
|
|
||||||
|
|
||||||
- **Automated HTTP checks**: Scheduled cron job checks all active services
|
|
||||||
- **Maintenance mode**: Temporarily disable monitoring during planned maintenance
|
|
||||||
- **Automatic maintenance requests**: Creates corrective maintenance requests
|
|
||||||
when services fail HTTP checks
|
|
||||||
- **Status tracking**: Records last HTTP status code and check date per service
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
Use Odoo normal module installation procedure to install
|
|
||||||
`maintenance_service_http_monitoring`.
|
|
||||||
|
|
||||||
This module depends on:
|
|
||||||
- `maintenance`
|
|
||||||
- `maintenance_server_data`
|
|
||||||
|
|
||||||
**Python dependencies**: This module requires the `requests` library.
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
## Maintenance Mode Duration
|
|
||||||
|
|
||||||
By default, maintenance mode lasts 4 hours. To change this:
|
|
||||||
|
|
||||||
1. Go to Settings > Technical > System Parameters
|
|
||||||
2. Create or edit the parameter:
|
|
||||||
- Key: `maintenance_service_http_monitoring.maintenance_mode_duration`
|
|
||||||
- Value: Duration in hours (e.g., `8`)
|
|
||||||
|
|
||||||
## Cron Jobs
|
|
||||||
|
|
||||||
Three scheduled actions are installed:
|
|
||||||
|
|
||||||
1. **HTTP Service Monitoring: check all services**
|
|
||||||
- Runs every 10 minutes
|
|
||||||
- Discovery sweep: checks HTTP status of all active service instances with URLs
|
|
||||||
and flags the start of a KO streak
|
|
||||||
|
|
||||||
2. **HTTP Service Monitoring: confirm KO services**
|
|
||||||
- Runs every 2 minutes
|
|
||||||
- Re-checks only the services currently flagged KO (without an open request) and
|
|
||||||
creates a maintenance request once the outage is confirmed
|
|
||||||
|
|
||||||
3. **HTTP Service Monitoring: deactivate expired maintenance mode**
|
|
||||||
- Runs every 15 minutes
|
|
||||||
- Automatically disables maintenance mode when the end time is reached
|
|
||||||
|
|
||||||
## Webhook Notifications
|
|
||||||
|
|
||||||
Go to **Settings > Technical > Parameters > System Parameters** and configure:
|
|
||||||
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
| Key | Description |
|
|
||||||
+========================================================+========================================+
|
|
||||||
| ``maintenance_service_http_monitoring.webhook_url`` | Webhook URL (POST endpoint) |
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
| ``maintenance_service_http_monitoring.webhook_user`` | Basic Auth username (optional) |
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
| ``maintenance_service_http_monitoring.webhook_password``| Basic Auth password (optional) |
|
|
||||||
+--------------------------------------------------------+----------------------------------------+
|
|
||||||
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Monitoring Services
|
|
||||||
|
|
||||||
Services are automatically monitored if they have:
|
|
||||||
- A service URL defined
|
|
||||||
- An associated equipment
|
|
||||||
- The equipment is not in maintenance mode
|
|
||||||
- The service instance is active
|
|
||||||
|
|
||||||
The monitoring checks HTTPS availability (HTTP URLs are automatically
|
|
||||||
upgraded to HTTPS). A service is considered OK if it returns HTTP 200.
|
|
||||||
|
|
||||||
## Using Maintenance Mode
|
|
||||||
|
|
||||||
When performing planned maintenance on a server:
|
|
||||||
|
|
||||||
1. Go to Maintenance > Equipments
|
|
||||||
2. Open the equipment record
|
|
||||||
3. Click "Activer le mode maintenance" (Activate maintenance mode)
|
|
||||||
4. HTTP monitoring is suspended for this equipment
|
|
||||||
5. The mode automatically expires after the configured duration
|
|
||||||
6. Or click "Désactiver le mode maintenance" to end it manually
|
|
||||||
|
|
||||||
## Viewing HTTP Status
|
|
||||||
|
|
||||||
On service instances, you can see:
|
|
||||||
- **Last HTTP Status Code**: The last received HTTP status (200, 404, 500, etc.)
|
|
||||||
- **Last HTTP Check Date**: When the last check was performed
|
|
||||||
- **HTTP Status OK**: Quick visual indicator of service health
|
|
||||||
|
|
||||||
## Automatic Maintenance Requests
|
|
||||||
|
|
||||||
When a service fails HTTP checks:
|
|
||||||
- The 10-minute discovery sweep flags the outage (``http_first_ko_at``) but does
|
|
||||||
**not** create a request yet
|
|
||||||
- The 2-minute confirmation cron re-checks the flagged services only. A request is
|
|
||||||
created once the service has been continuously KO for at least 2 minutes
|
|
||||||
(``HTTP_KO_CONFIRMATION_DELAY``), so a short transient outage is not flagged
|
|
||||||
- A corrective maintenance request is created per failing service, named
|
|
||||||
``[HTTP KO] {service_url}``
|
|
||||||
- The request description includes the error detail: the HTTP status code,
|
|
||||||
or a network error label (timeout / DNS / SSL) when no HTTP response was received
|
|
||||||
- No duplicate is created as long as an open request already exists for that service
|
|
||||||
- The confirmation cron skips services that already have an open request; those are
|
|
||||||
handled by the discovery sweep
|
|
||||||
|
|
||||||
When a service recovers (returns HTTP 200 after having an open request):
|
|
||||||
- The open maintenance request is automatically moved to the first **done** stage
|
|
||||||
- A chatter note is posted on the request by OdooBot to record the automatic closure
|
|
||||||
- The link between the service and the request is cleared, allowing a new request to
|
|
||||||
be created if the service fails again in the future
|
|
||||||
|
|
||||||
## Webhook notifications
|
|
||||||
|
|
||||||
When a new maintenance request is created (HTTP check failure), the module can
|
|
||||||
send a webhook notification to an external service (e.g., n8n, Rocket.Chat, Slack).
|
|
||||||
|
|
||||||
The webhook sends a JSON POST with the following structure::
|
|
||||||
|
|
||||||
{
|
|
||||||
"id": 42,
|
|
||||||
"name": "[HTTP KO] Server Name",
|
|
||||||
"priority": "2",
|
|
||||||
"description": "Service KO: https://example.com",
|
|
||||||
"equipment": "Server Name",
|
|
||||||
"link": "https://odoo.example.com/web#id=42&model=maintenance.request&view_type=form"
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# Known issues / Roadmap
|
|
||||||
|
|
||||||
- Add configurable alert thresholds (e.g., alert after N consecutive failures)
|
|
||||||
- Add email/notification on service failure
|
|
||||||
- Support custom HTTP check endpoints (e.g., /health)
|
|
||||||
- Add support for basic authentication
|
|
||||||
|
|
||||||
# Bug Tracker
|
|
||||||
|
|
||||||
Bugs are tracked on
|
|
||||||
[our issues website](https://github.com/elabore-coop/maintenance-tools/issues). In
|
|
||||||
case of trouble, please check there if your issue has already been reported. If you
|
|
||||||
spotted it first, help us smashing it by providing a detailed and welcomed feedback.
|
|
||||||
|
|
||||||
# Credits
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
- Stéphan Sainléger
|
|
||||||
|
|
||||||
## Funders
|
|
||||||
|
|
||||||
The development of this module has been financially supported by:
|
|
||||||
|
|
||||||
- Elabore (https://elabore.coop)
|
|
||||||
|
|
||||||
## Maintainer
|
|
||||||
|
|
||||||
This module is maintained by Elabore.
|
|
||||||
@@ -5,10 +5,9 @@
|
|||||||
"license": "AGPL-3",
|
"license": "AGPL-3",
|
||||||
"category": "Tools",
|
"category": "Tools",
|
||||||
"summary": "Monitor HTTP availability of services",
|
"summary": "Monitor HTTP availability of services",
|
||||||
"depends": ["base", "maintenance", "base_maintenance", "hr_maintenance", "maintenance_server_data"],
|
"depends": ["base", "maintenance", "maintenance_server_data"],
|
||||||
"external_dependencies": {"python": ["requests"]},
|
"external_dependencies": {"python": ["requests"]},
|
||||||
"data": [
|
"data": [
|
||||||
"data/ir_config_parameter.xml",
|
|
||||||
"data/cron.xml",
|
"data/cron.xml",
|
||||||
"views/service_instance_views.xml",
|
"views/service_instance_views.xml",
|
||||||
"views/maintenance_equipment_views.xml",
|
"views/maintenance_equipment_views.xml",
|
||||||
|
|||||||
@@ -5,15 +5,7 @@
|
|||||||
<field name="model_id" ref="maintenance_server_data.model_service_instance" />
|
<field name="model_id" ref="maintenance_server_data.model_service_instance" />
|
||||||
<field name="state">code</field>
|
<field name="state">code</field>
|
||||||
<field name="code">model.cron_check_http_services()</field>
|
<field name="code">model.cron_check_http_services()</field>
|
||||||
<field name="interval_number">10</field>
|
<field name="interval_number">15</field>
|
||||||
<field name="interval_type">minutes</field>
|
|
||||||
</record>
|
|
||||||
<record id="ir_cron_http_service_confirmation" model="ir.cron">
|
|
||||||
<field name="name">HTTP Service Monitoring : confirm KO services</field>
|
|
||||||
<field name="model_id" ref="maintenance_server_data.model_service_instance" />
|
|
||||||
<field name="state">code</field>
|
|
||||||
<field name="code">model.cron_confirm_http_ko_services()</field>
|
|
||||||
<field name="interval_number">2</field>
|
|
||||||
<field name="interval_type">minutes</field>
|
<field name="interval_type">minutes</field>
|
||||||
</record>
|
</record>
|
||||||
<record id="ir_cron_maintenance_mode_expiry" model="ir.cron">
|
<record id="ir_cron_maintenance_mode_expiry" model="ir.cron">
|
||||||
|
|||||||
@@ -1,15 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<odoo noupdate="1">
|
|
||||||
<record id="config_param_webhook_url" model="ir.config_parameter">
|
|
||||||
<field name="key">maintenance_service_http_monitoring.webhook_url</field>
|
|
||||||
<field name="value"></field>
|
|
||||||
</record>
|
|
||||||
<record id="config_param_webhook_user" model="ir.config_parameter">
|
|
||||||
<field name="key">maintenance_service_http_monitoring.webhook_user</field>
|
|
||||||
<field name="value"></field>
|
|
||||||
</record>
|
|
||||||
<record id="config_param_webhook_password" model="ir.config_parameter">
|
|
||||||
<field name="key">maintenance_service_http_monitoring.webhook_password</field>
|
|
||||||
<field name="value"></field>
|
|
||||||
</record>
|
|
||||||
</odoo>
|
|
||||||
@@ -1,32 +1,30 @@
|
|||||||
import logging
|
|
||||||
from datetime import timedelta
|
from datetime import timedelta
|
||||||
|
|
||||||
from odoo import api, fields, models
|
from odoo import api, fields, models
|
||||||
|
|
||||||
try:
|
|
||||||
import requests as http_requests
|
|
||||||
except ImportError:
|
|
||||||
http_requests = None
|
|
||||||
|
|
||||||
_logger = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
WEBHOOK_TIMEOUT = 10 # seconds
|
|
||||||
|
|
||||||
|
|
||||||
class MaintenanceEquipment(models.Model):
|
class MaintenanceEquipment(models.Model):
|
||||||
_inherit = "maintenance.equipment"
|
_inherit = "maintenance.equipment"
|
||||||
|
|
||||||
maintenance_mode = fields.Boolean(
|
maintenance_mode = fields.Boolean(
|
||||||
|
string="Maintenance Mode",
|
||||||
default=False,
|
default=False,
|
||||||
tracking=True,
|
tracking=True,
|
||||||
)
|
)
|
||||||
maintenance_mode_start = fields.Datetime(
|
maintenance_mode_start = fields.Datetime(
|
||||||
|
string="Maintenance Mode Start",
|
||||||
readonly=True,
|
readonly=True,
|
||||||
)
|
)
|
||||||
maintenance_mode_end = fields.Datetime(
|
maintenance_mode_end = fields.Datetime(
|
||||||
|
string="Maintenance Mode End",
|
||||||
readonly=True,
|
readonly=True,
|
||||||
help="Computed from start + configured duration",
|
help="Computed from start + configured duration",
|
||||||
)
|
)
|
||||||
|
http_maintenance_request = fields.Many2one(
|
||||||
|
"maintenance.request",
|
||||||
|
string="HTTP Maintenance Request",
|
||||||
|
readonly=True,
|
||||||
|
)
|
||||||
|
|
||||||
def action_activate_maintenance_mode(self):
|
def action_activate_maintenance_mode(self):
|
||||||
for rec in self:
|
for rec in self:
|
||||||
@@ -67,30 +65,31 @@ class MaintenanceEquipment(models.Model):
|
|||||||
)
|
)
|
||||||
expired.action_deactivate_maintenance_mode()
|
expired.action_deactivate_maintenance_mode()
|
||||||
|
|
||||||
def create_http_maintenance_request(self, ko_service):
|
def create_http_maintenance_request(self, ko_services):
|
||||||
"""
|
|
||||||
Create or return the open maintenance.request for a single KO service.
|
|
||||||
|
|
||||||
Deduplication: if ko_service already has an open (non-done) request,
|
|
||||||
return it without creating a new one.
|
|
||||||
"""
|
|
||||||
self.ensure_one()
|
self.ensure_one()
|
||||||
existing = ko_service.http_maintenance_request
|
today = fields.Date.context_today(self)
|
||||||
if existing and not existing.stage_id.done:
|
name = f"[HTTP KO] {self.name}"
|
||||||
|
domain = [
|
||||||
|
("name", "=", name),
|
||||||
|
("equipment_id", "=", self.id),
|
||||||
|
("maintenance_type", "=", "corrective"),
|
||||||
|
("create_date", ">=", f"{today} 00:00:00"),
|
||||||
|
("create_date", "<=", f"{today} 23:59:59"),
|
||||||
|
]
|
||||||
|
existing = self.env["maintenance.request"].search(domain, limit=1)
|
||||||
|
# Check if a task with same name already exist for the day, if it’s the case : skip
|
||||||
|
if existing:
|
||||||
|
self.http_maintenance_request = existing.id
|
||||||
return existing
|
return existing
|
||||||
status_code = ko_service.last_http_status_code
|
request = self.http_maintenance_request
|
||||||
if status_code == -1:
|
if request and not request.stage_id.done:
|
||||||
error_detail = "Erreur réseau (timeout / DNS / SSL)"
|
return request
|
||||||
else:
|
|
||||||
error_detail = f"HTTP {status_code}"
|
|
||||||
name = f"[HTTP KO] {ko_service.service_url}"
|
|
||||||
description = f"Service KO: {ko_service.service_url}\n{error_detail}"
|
|
||||||
vals = {
|
vals = {
|
||||||
"name": name,
|
"name": name,
|
||||||
"equipment_id": self.id,
|
"equipment_id": self.id,
|
||||||
"priority": "2",
|
"priority": "2",
|
||||||
"maintenance_type": "corrective",
|
"maintenance_type": "corrective",
|
||||||
"description": description,
|
"description": self._build_ko_services_description(ko_services),
|
||||||
}
|
}
|
||||||
if self.employee_id:
|
if self.employee_id:
|
||||||
vals["employee_id"] = self.employee_id.id
|
vals["employee_id"] = self.employee_id.id
|
||||||
@@ -103,50 +102,9 @@ class MaintenanceEquipment(models.Model):
|
|||||||
if team:
|
if team:
|
||||||
vals["maintenance_team_id"] = team.id
|
vals["maintenance_team_id"] = team.id
|
||||||
request = self.env["maintenance.request"].create(vals)
|
request = self.env["maintenance.request"].create(vals)
|
||||||
ko_service.http_maintenance_request = request.id
|
self.http_maintenance_request = request.id
|
||||||
self._notify_webhook(request, ko_service)
|
|
||||||
return request
|
return request
|
||||||
|
|
||||||
def _notify_webhook(self, request, ko_service):
|
def _build_ko_services_description(self, ko_services):
|
||||||
"""
|
lines = [f"Service KO: {s.service_url or s.name}" for s in ko_services]
|
||||||
Send a webhook notification when a new maintenance request is created.
|
return "\n".join(lines)
|
||||||
"""
|
|
||||||
ICP = self.env["ir.config_parameter"].sudo()
|
|
||||||
webhook_url = ICP.get_param(
|
|
||||||
"maintenance_service_http_monitoring.webhook_url", ""
|
|
||||||
)
|
|
||||||
if not webhook_url:
|
|
||||||
return
|
|
||||||
webhook_user = ICP.get_param(
|
|
||||||
"maintenance_service_http_monitoring.webhook_user", ""
|
|
||||||
)
|
|
||||||
webhook_password = ICP.get_param(
|
|
||||||
"maintenance_service_http_monitoring.webhook_password", ""
|
|
||||||
)
|
|
||||||
base_url = ICP.get_param("web.base.url", "")
|
|
||||||
link = (
|
|
||||||
f"{base_url}/web#id={request.id}&model=maintenance.request&view_type=form"
|
|
||||||
)
|
|
||||||
payload = {
|
|
||||||
"id": request.id,
|
|
||||||
"name": request.name,
|
|
||||||
"description": request.description or "",
|
|
||||||
"equipment": self.name,
|
|
||||||
"link": link,
|
|
||||||
}
|
|
||||||
auth = None
|
|
||||||
if webhook_user and webhook_password:
|
|
||||||
auth = (webhook_user, webhook_password)
|
|
||||||
try:
|
|
||||||
http_requests.post(
|
|
||||||
webhook_url,
|
|
||||||
json=payload,
|
|
||||||
auth=auth,
|
|
||||||
timeout=WEBHOOK_TIMEOUT,
|
|
||||||
)
|
|
||||||
except Exception as e:
|
|
||||||
_logger.warning(
|
|
||||||
"Webhook notification failed for maintenance request %s: %s",
|
|
||||||
request.id,
|
|
||||||
e,
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -1,5 +1,4 @@
|
|||||||
import logging
|
import logging
|
||||||
from datetime import timedelta
|
|
||||||
|
|
||||||
from odoo import api, fields, models
|
from odoo import api, fields, models
|
||||||
|
|
||||||
@@ -10,8 +9,7 @@ except ImportError:
|
|||||||
|
|
||||||
_logger = logging.getLogger(__name__)
|
_logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
HTTP_CHECK_TIMEOUT = 20 # seconds
|
HTTP_CHECK_TIMEOUT = 10 # seconds
|
||||||
HTTP_KO_CONFIRMATION_DELAY = timedelta(minutes=2)
|
|
||||||
|
|
||||||
|
|
||||||
class ServiceInstance(models.Model):
|
class ServiceInstance(models.Model):
|
||||||
@@ -31,33 +29,13 @@ class ServiceInstance(models.Model):
|
|||||||
readonly=True,
|
readonly=True,
|
||||||
default=True,
|
default=True,
|
||||||
)
|
)
|
||||||
http_maintenance_request = fields.Many2one(
|
|
||||||
"maintenance.request",
|
|
||||||
string="HTTP Maintenance Request",
|
|
||||||
readonly=True,
|
|
||||||
)
|
|
||||||
http_first_ko_at = fields.Datetime(
|
|
||||||
string="First HTTP KO Check (current streak)",
|
|
||||||
readonly=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
def check_http_status(self):
|
def check_http_status(self):
|
||||||
"""
|
|
||||||
Perform HTTP check for each record and return the KO recordset.
|
|
||||||
|
|
||||||
Writes last_http_status_code, last_http_check_date and http_status_ok on every
|
|
||||||
checked record, and maintains http_first_ko_at (the start of the current KO
|
|
||||||
streak, reset as soon as the service is OK again). Does NOT create
|
|
||||||
maintenance.request — that decision belongs to cron_confirm_http_ko_services,
|
|
||||||
once the service has been continuously KO for at least
|
|
||||||
HTTP_KO_CONFIRMATION_DELAY, to avoid flagging transient outages (e.g. a short
|
|
||||||
server overload) as real incidents.
|
|
||||||
"""
|
|
||||||
ko_records = self.browse()
|
|
||||||
for rec in self:
|
for rec in self:
|
||||||
if not rec.service_url or not rec.equipment_id:
|
if not rec.service_url or not rec.equipment_id:
|
||||||
continue
|
continue
|
||||||
if rec.equipment_id.maintenance_mode:
|
equipment = rec.equipment_id
|
||||||
|
if getattr(equipment, "maintenance_mode", False):
|
||||||
continue
|
continue
|
||||||
status_ok = False
|
status_ok = False
|
||||||
status_code = -1
|
status_code = -1
|
||||||
@@ -71,110 +49,28 @@ class ServiceInstance(models.Model):
|
|||||||
status_ok = status_code == 200
|
status_ok = status_code == 200
|
||||||
except requests.exceptions.RequestException as e:
|
except requests.exceptions.RequestException as e:
|
||||||
_logger.warning("HTTP check failed for %s: %s", rec.service_url, e)
|
_logger.warning("HTTP check failed for %s: %s", rec.service_url, e)
|
||||||
vals = {
|
rec.write(
|
||||||
"last_http_status_code": status_code,
|
{
|
||||||
"last_http_check_date": now,
|
"last_http_status_code": status_code,
|
||||||
"http_status_ok": status_ok,
|
"last_http_check_date": now,
|
||||||
}
|
"http_status_ok": status_ok,
|
||||||
if status_ok:
|
}
|
||||||
vals["http_first_ko_at"] = False
|
|
||||||
elif not rec.http_first_ko_at:
|
|
||||||
vals["http_first_ko_at"] = now
|
|
||||||
rec.write(vals)
|
|
||||||
if not status_ok:
|
|
||||||
ko_records |= rec
|
|
||||||
return ko_records
|
|
||||||
|
|
||||||
def _close_http_maintenance_request(self):
|
|
||||||
"""
|
|
||||||
Close the open maintenance.request for each recovered service.
|
|
||||||
|
|
||||||
Moves the request to the first done stage, posts a chatter note as OdooBot, and
|
|
||||||
clears http_maintenance_request on the service instance.
|
|
||||||
"""
|
|
||||||
done_stage = self.env["maintenance.stage"].search(
|
|
||||||
[("done", "=", True)], limit=1
|
|
||||||
)
|
|
||||||
if not done_stage:
|
|
||||||
return
|
|
||||||
odoobot = self.env.ref("base.partner_root")
|
|
||||||
for rec in self:
|
|
||||||
request = rec.http_maintenance_request
|
|
||||||
if not request or request.stage_id.done:
|
|
||||||
continue
|
|
||||||
request.sudo().write({"stage_id": done_stage.id})
|
|
||||||
request.sudo().message_post(
|
|
||||||
body=(
|
|
||||||
f"Service {rec.service_url} is back online. "
|
|
||||||
"This request has been automatically closed by the monitoring cron."
|
|
||||||
),
|
|
||||||
author_id=odoobot.id,
|
|
||||||
message_type="comment",
|
|
||||||
subtype_xmlid="mail.mt_note",
|
|
||||||
)
|
)
|
||||||
rec.http_maintenance_request = False
|
if not status_ok:
|
||||||
|
# Delegate maintenance.request creation to equipment
|
||||||
|
if hasattr(equipment, "create_http_maintenance_request"):
|
||||||
|
equipment.create_http_maintenance_request([rec])
|
||||||
|
|
||||||
@api.model
|
@api.model
|
||||||
def cron_check_http_services(self):
|
def cron_check_http_services(self):
|
||||||
"""
|
|
||||||
Discovery sweep: check all active services with a URL.
|
|
||||||
|
|
||||||
This cron only detects outages — it flags the start of a KO streak through
|
|
||||||
http_first_ko_at (via check_http_status) and auto-resolves services that
|
|
||||||
recovered. Maintenance requests are created by the separate, faster
|
|
||||||
cron_confirm_http_ko_services once the outage is confirmed.
|
|
||||||
"""
|
|
||||||
domain = [
|
domain = [
|
||||||
("active", "=", True),
|
("active", "=", True),
|
||||||
("service_url", "!=", False),
|
("service_url", "!=", False),
|
||||||
("equipment_id", "!=", False),
|
("equipment_id", "!=", False),
|
||||||
]
|
]
|
||||||
services = self.search(domain).filtered(
|
services = self.search(domain)
|
||||||
lambda s: not s.equipment_id.maintenance_mode
|
for service in services:
|
||||||
)
|
equipment = service.equipment_id
|
||||||
|
if getattr(equipment, "maintenance_mode", False):
|
||||||
# Snapshot services that currently have an open request before the check
|
continue
|
||||||
services_with_open_request = services.filtered(
|
service.check_http_status()
|
||||||
lambda s: s.http_maintenance_request
|
|
||||||
and not s.http_maintenance_request.stage_id.done
|
|
||||||
)
|
|
||||||
|
|
||||||
services.check_http_status()
|
|
||||||
|
|
||||||
# Auto-resolve services that recovered
|
|
||||||
recovered = services_with_open_request.filtered(lambda s: s.http_status_ok)
|
|
||||||
if recovered:
|
|
||||||
recovered._close_http_maintenance_request()
|
|
||||||
|
|
||||||
@api.model
|
|
||||||
def cron_confirm_http_ko_services(self):
|
|
||||||
"""
|
|
||||||
Confirmation pass: re-check services currently flagged KO and create their
|
|
||||||
maintenance.request once the outage is confirmed.
|
|
||||||
|
|
||||||
Only services without an open request are considered (re-checking a service
|
|
||||||
already under an open request is pointless). A service must be continuously
|
|
||||||
KO for at least HTTP_KO_CONFIRMATION_DELAY: a service that recovered in the
|
|
||||||
meantime resets http_first_ko_at via check_http_status and no request is
|
|
||||||
created. Services already under an open request are handled by the slower
|
|
||||||
discovery cron, which also auto-resolves them when they recover.
|
|
||||||
"""
|
|
||||||
domain = [
|
|
||||||
("active", "=", True),
|
|
||||||
("service_url", "!=", False),
|
|
||||||
("equipment_id", "!=", False),
|
|
||||||
("http_first_ko_at", "!=", False),
|
|
||||||
("http_maintenance_request", "=", False),
|
|
||||||
]
|
|
||||||
services = self.search(domain).filtered(
|
|
||||||
lambda s: not s.equipment_id.maintenance_mode
|
|
||||||
)
|
|
||||||
|
|
||||||
ko_services = services.check_http_status()
|
|
||||||
|
|
||||||
confirmed_ko = ko_services.filtered(
|
|
||||||
lambda s: s.last_http_check_date - s.http_first_ko_at
|
|
||||||
>= HTTP_KO_CONFIRMATION_DELAY
|
|
||||||
)
|
|
||||||
for service in confirmed_ko:
|
|
||||||
service.equipment_id.create_http_maintenance_request(service)
|
|
||||||
|
|||||||
@@ -1 +0,0 @@
|
|||||||
from . import test_http_monitoring
|
|
||||||
@@ -1,468 +0,0 @@
|
|||||||
from datetime import timedelta
|
|
||||||
from unittest.mock import MagicMock, patch
|
|
||||||
|
|
||||||
from odoo import fields
|
|
||||||
from odoo.tests.common import TransactionCase
|
|
||||||
|
|
||||||
SERVICE_INSTANCE_REQUESTS = (
|
|
||||||
"odoo.addons.maintenance_service_http_monitoring.models.service_instance.requests"
|
|
||||||
)
|
|
||||||
EQUIPMENT_HTTP_REQUESTS = (
|
|
||||||
"odoo.addons.maintenance_service_http_monitoring"
|
|
||||||
".models.maintenance_equipment.http_requests"
|
|
||||||
)
|
|
||||||
|
|
||||||
# Comfortably past HTTP_KO_CONFIRMATION_DELAY (currently 2 minutes).
|
|
||||||
PAST_CONFIRMATION_DELAY = timedelta(minutes=10)
|
|
||||||
|
|
||||||
|
|
||||||
def _mock_response(status_code):
|
|
||||||
response = MagicMock()
|
|
||||||
response.status_code = status_code
|
|
||||||
return response
|
|
||||||
|
|
||||||
|
|
||||||
class TestHttpMonitoring(TransactionCase):
|
|
||||||
def setUp(self):
|
|
||||||
super().setUp()
|
|
||||||
team = self.env["maintenance.team"].search([], limit=1)
|
|
||||||
self.equipment = self.env["maintenance.equipment"].create(
|
|
||||||
{
|
|
||||||
"name": "Test Server",
|
|
||||||
"maintenance_team_id": team.id if team else False,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
self.service = self.env["service"].create({"name": "Test Service"})
|
|
||||||
self.service_instance = self.env["service.instance"].create(
|
|
||||||
{
|
|
||||||
"equipment_id": self.equipment.id,
|
|
||||||
"service_id": self.service.id,
|
|
||||||
"service_url": "https://example.com",
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
def _backdate_first_ko(self, *service_instances):
|
|
||||||
"""Simulate a KO streak old enough ago to be confirmed."""
|
|
||||||
for service_instance in service_instances:
|
|
||||||
service_instance.write(
|
|
||||||
{"http_first_ko_at": fields.Datetime.now() - PAST_CONFIRMATION_DELAY}
|
|
||||||
)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 1 -- HTTP 200 -> service marked OK
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_http_200_sets_status_ok(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(200)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.service_instance.check_http_status()
|
|
||||||
|
|
||||||
self.assertTrue(self.service_instance.http_status_ok)
|
|
||||||
self.assertEqual(self.service_instance.last_http_status_code, 200)
|
|
||||||
self.assertIsNotNone(self.service_instance.last_http_check_date)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 2 -- KO confirmed only once continuously KO for HTTP_KO_CONFIRMATION_DELAY,
|
|
||||||
# not on the first observed failure
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_http_500_creates_request_after_confirmation_delay(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self.assertFalse(self.service_instance.http_status_ok)
|
|
||||||
self.assertEqual(self.service_instance.last_http_status_code, 500)
|
|
||||||
self.assertTrue(self.service_instance.http_first_ko_at)
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
|
|
||||||
self._backdate_first_ko(self.service_instance)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
request = self.service_instance.http_maintenance_request
|
|
||||||
self.assertTrue(request)
|
|
||||||
self.assertEqual(request.name, f"[HTTP KO] {self.service_instance.service_url}")
|
|
||||||
self.assertEqual(request.priority, "2")
|
|
||||||
self.assertEqual(request.maintenance_type, "corrective")
|
|
||||||
self.assertIn("HTTP 500", request.description)
|
|
||||||
self.assertIn(self.service_instance.service_url, request.description)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 3 -- Network error -> KO with code -1
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_network_error_sets_status_ko_and_minus_one(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.side_effect = Exception("connection refused")
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.service_instance.check_http_status()
|
|
||||||
|
|
||||||
self.assertFalse(self.service_instance.http_status_ok)
|
|
||||||
self.assertEqual(self.service_instance.last_http_status_code, -1)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 4 -- Repeated failure after confirmation -> a single request, no duplicate
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_no_duplicate_request_on_repeated_failure(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services() # first_ko_at set
|
|
||||||
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
self._backdate_first_ko(self.service_instance)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
# confirmed -> request created
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
request_1 = self.service_instance.http_maintenance_request
|
|
||||||
self.assertTrue(request_1)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
# already handled -> skipped
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
# Service already has an open request -> the confirmation cron skips it
|
|
||||||
mock_requests.get.assert_not_called()
|
|
||||||
self.assertEqual(self.service_instance.http_maintenance_request, request_1)
|
|
||||||
self.assertEqual(
|
|
||||||
self.env["maintenance.request"].search_count(
|
|
||||||
[("equipment_id", "=", self.equipment.id)]
|
|
||||||
),
|
|
||||||
1,
|
|
||||||
)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 5 -- Equipment in maintenance mode -> cron skips it
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_maintenance_mode_skips_http_check(self):
|
|
||||||
self.equipment.write({"maintenance_mode": True})
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
mock_requests.get.assert_not_called()
|
|
||||||
self.assertFalse(self.service_instance.last_http_check_date)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 6 -- Expired maintenance mode -> cron deactivates it
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_maintenance_mode_auto_expiry(self):
|
|
||||||
past = fields.Datetime.now() - timedelta(hours=1)
|
|
||||||
self.equipment.write(
|
|
||||||
{
|
|
||||||
"maintenance_mode": True,
|
|
||||||
"maintenance_mode_start": past - timedelta(hours=4),
|
|
||||||
"maintenance_mode_end": past,
|
|
||||||
}
|
|
||||||
)
|
|
||||||
self.assertTrue(self.equipment.maintenance_mode)
|
|
||||||
|
|
||||||
self.env["maintenance.equipment"].cron_deactivate_expired_maintenance_mode()
|
|
||||||
|
|
||||||
self.assertFalse(self.equipment.maintenance_mode)
|
|
||||||
self.assertFalse(self.equipment.maintenance_mode_start)
|
|
||||||
self.assertFalse(self.equipment.maintenance_mode_end)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 7 -- Service without URL -> ignored by cron
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_service_without_url_is_ignored(self):
|
|
||||||
self.service_instance.write({"service_url": False})
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(200)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
mock_requests.get.assert_not_called()
|
|
||||||
self.assertFalse(self.service_instance.last_http_check_date)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 8 -- HTTP 404 (non-exception) -> KO with correct code
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_http_non_200_non_exception(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(404)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.service_instance.check_http_status()
|
|
||||||
|
|
||||||
self.assertFalse(self.service_instance.http_status_ok)
|
|
||||||
self.assertEqual(self.service_instance.last_http_status_code, 404)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 9 -- Webhook called only once the request is actually created
|
|
||||||
# (after confirmation delay), not on the first observed failure
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_webhook_called_on_new_request(self):
|
|
||||||
self.env["ir.config_parameter"].sudo().set_param(
|
|
||||||
"maintenance_service_http_monitoring.webhook_url",
|
|
||||||
"https://webhook.example.com/hook",
|
|
||||||
)
|
|
||||||
with (
|
|
||||||
patch(SERVICE_INSTANCE_REQUESTS) as mock_requests,
|
|
||||||
patch(EQUIPMENT_HTTP_REQUESTS) as mock_http,
|
|
||||||
):
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
mock_http.post.assert_not_called()
|
|
||||||
self._backdate_first_ko(self.service_instance)
|
|
||||||
|
|
||||||
with (
|
|
||||||
patch(SERVICE_INSTANCE_REQUESTS) as mock_requests,
|
|
||||||
patch(EQUIPMENT_HTTP_REQUESTS) as mock_http,
|
|
||||||
):
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
mock_http.post.assert_called_once()
|
|
||||||
call_kwargs = mock_http.post.call_args
|
|
||||||
payload = call_kwargs.kwargs.get("json") or call_kwargs[1].get("json")
|
|
||||||
self.assertEqual(payload["equipment"], self.equipment.name)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 10 -- Webhook skipped when no URL configured
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_webhook_skipped_when_no_url(self):
|
|
||||||
self.env["ir.config_parameter"].sudo().set_param(
|
|
||||||
"maintenance_service_http_monitoring.webhook_url", ""
|
|
||||||
)
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self._backdate_first_ko(self.service_instance)
|
|
||||||
|
|
||||||
with (
|
|
||||||
patch(SERVICE_INSTANCE_REQUESTS) as mock_requests,
|
|
||||||
patch(EQUIPMENT_HTTP_REQUESTS) as mock_http,
|
|
||||||
):
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
self.assertTrue(self.service_instance.http_maintenance_request)
|
|
||||||
mock_http.post.assert_not_called()
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 11 -- Service without equipment -> check_http_status skips it
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_service_without_equipment_is_ignored(self):
|
|
||||||
self.service_instance.write({"equipment_id": False})
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(200)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.service_instance.check_http_status()
|
|
||||||
|
|
||||||
mock_requests.get.assert_not_called()
|
|
||||||
self.assertFalse(self.service_instance.last_http_check_date)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 12 -- Transient failure (KO, then back OK before confirmation) ->
|
|
||||||
# no request created, and the KO streak is reset
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_transient_failure_no_request_created(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self.assertTrue(self.service_instance.http_first_ko_at)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(200)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
self.assertTrue(self.service_instance.http_status_ok)
|
|
||||||
self.assertEqual(self.service_instance.last_http_status_code, 200)
|
|
||||||
self.assertFalse(self.service_instance.http_first_ko_at)
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
self.assertEqual(
|
|
||||||
self.env["maintenance.request"].search_count(
|
|
||||||
[("equipment_id", "=", self.equipment.id)]
|
|
||||||
),
|
|
||||||
0,
|
|
||||||
)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 13 -- Confirmed failure (KO continuously past the confirmation delay)
|
|
||||||
# -> request created
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_confirmed_failure_creates_request(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(503)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self.assertEqual(mock_requests.get.call_count, 1)
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
|
|
||||||
self._backdate_first_ko(self.service_instance)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(503)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
self.assertEqual(mock_requests.get.call_count, 1)
|
|
||||||
self.assertFalse(self.service_instance.http_status_ok)
|
|
||||||
self.assertEqual(self.service_instance.last_http_status_code, 503)
|
|
||||||
self.assertTrue(self.service_instance.http_maintenance_request)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 14 -- 2 KO services on same equipment -> 2 distinct requests
|
|
||||||
# once both reach the confirmation delay
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_two_ko_services_same_equipment_create_two_requests(self):
|
|
||||||
service2 = self.env["service"].create({"name": "Test Service 2"})
|
|
||||||
service_instance2 = self.env["service.instance"].create(
|
|
||||||
{
|
|
||||||
"equipment_id": self.equipment.id,
|
|
||||||
"service_id": service2.id,
|
|
||||||
"service_url": "https://other.example.com",
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self._backdate_first_ko(self.service_instance, service_instance2)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
req1 = self.service_instance.http_maintenance_request
|
|
||||||
req2 = service_instance2.http_maintenance_request
|
|
||||||
|
|
||||||
self.assertTrue(req1)
|
|
||||||
self.assertTrue(req2)
|
|
||||||
self.assertNotEqual(req1, req2)
|
|
||||||
self.assertEqual(req1.name, f"[HTTP KO] {self.service_instance.service_url}")
|
|
||||||
self.assertEqual(req2.name, f"[HTTP KO] {service_instance2.service_url}")
|
|
||||||
self.assertEqual(
|
|
||||||
self.env["maintenance.request"].search_count(
|
|
||||||
[("equipment_id", "=", self.equipment.id)]
|
|
||||||
),
|
|
||||||
2,
|
|
||||||
)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 15 -- Service recovery closes the open request and posts a note
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_service_recovery_closes_request(self):
|
|
||||||
# First cron run: service is KO, streak just started -> no request yet
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self._backdate_first_ko(self.service_instance)
|
|
||||||
|
|
||||||
# Confirmation cron run: streak confirmed -> request created
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
request = self.service_instance.http_maintenance_request
|
|
||||||
self.assertTrue(request)
|
|
||||||
self.assertFalse(request.stage_id.done)
|
|
||||||
|
|
||||||
# Next cron run: service is back OK -> request auto-closed
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(200)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
# Request must be in a done stage
|
|
||||||
self.assertTrue(request.stage_id.done)
|
|
||||||
# http_maintenance_request must be cleared on the service instance
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
# KO streak must be reset
|
|
||||||
self.assertFalse(self.service_instance.http_first_ko_at)
|
|
||||||
# A chatter note must have been posted mentioning the service URL
|
|
||||||
notes = request.message_ids.filtered(
|
|
||||||
lambda m: self.service_instance.service_url in (m.body or "")
|
|
||||||
)
|
|
||||||
self.assertTrue(notes)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 16 -- No open request -> _close_http_maintenance_request is a no-op
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_no_close_when_no_open_request(self):
|
|
||||||
# Service is OK from the start, no request exists
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
# Calling close directly must not raise
|
|
||||||
self.service_instance._close_http_maintenance_request()
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 17 -- Confirmation cron ignores services without a KO streak
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_confirmation_cron_ignores_unflagged_services(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(200)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
mock_requests.get.assert_not_called()
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 18 -- Confirmation cron does not create a request before
|
|
||||||
# HTTP_KO_CONFIRMATION_DELAY has elapsed
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_confirmation_cron_waits_for_confirmation_delay(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self.assertTrue(self.service_instance.http_first_ko_at)
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
# Test 19 -- Confirmation cron ignores services whose equipment is in
|
|
||||||
# maintenance mode
|
|
||||||
# ------------------------------------------------------------------
|
|
||||||
def test_confirmation_cron_skips_maintenance_mode(self):
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_check_http_services()
|
|
||||||
|
|
||||||
self.assertTrue(self.service_instance.http_first_ko_at)
|
|
||||||
self.equipment.write({"maintenance_mode": True})
|
|
||||||
|
|
||||||
with patch(SERVICE_INSTANCE_REQUESTS) as mock_requests:
|
|
||||||
mock_requests.get.return_value = _mock_response(500)
|
|
||||||
mock_requests.exceptions.RequestException = Exception
|
|
||||||
self.env["service.instance"].cron_confirm_http_ko_services()
|
|
||||||
|
|
||||||
mock_requests.get.assert_not_called()
|
|
||||||
self.assertFalse(self.service_instance.http_maintenance_request)
|
|
||||||
@@ -36,6 +36,7 @@
|
|||||||
<field name="maintenance_mode" />
|
<field name="maintenance_mode" />
|
||||||
<field name="maintenance_mode_start" />
|
<field name="maintenance_mode_start" />
|
||||||
<field name="maintenance_mode_end" />
|
<field name="maintenance_mode_end" />
|
||||||
|
<field name="http_maintenance_request" readonly="1" />
|
||||||
</group>
|
</group>
|
||||||
</page>
|
</page>
|
||||||
</xpath>
|
</xpath>
|
||||||
|
|||||||
@@ -17,8 +17,6 @@
|
|||||||
<field name="last_http_check_date" />
|
<field name="last_http_check_date" />
|
||||||
<field name="last_http_status_code" />
|
<field name="last_http_status_code" />
|
||||||
<field name="http_status_ok" />
|
<field name="http_status_ok" />
|
||||||
<field name="http_maintenance_request" optional="hide" />
|
|
||||||
<field name="http_first_ko_at" optional="hide" />
|
|
||||||
</field>
|
</field>
|
||||||
</field>
|
</field>
|
||||||
</record>
|
</record>
|
||||||
|
|||||||
2
maintenance_user_ssh_key/.gitignore
vendored
2
maintenance_user_ssh_key/.gitignore
vendored
@@ -1,2 +0,0 @@
|
|||||||
*.*~
|
|
||||||
*pyc
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
==============================
|
|
||||||
maintenance_user_ssh_key
|
|
||||||
==============================
|
|
||||||
|
|
||||||
This module adds SSH key management to Odoo users. It introduces a new
|
|
||||||
``ssh.key`` model and a ``ssh_key_ids`` One2many field on ``res.users``.
|
|
||||||
|
|
||||||
It allows administrators to associate SSH public keys with each user for
|
|
||||||
authentication purposes (e.g., remote server access, deployment).
|
|
||||||
|
|
||||||
Features:
|
|
||||||
|
|
||||||
- **SSH Key model**: Store public keys per user.
|
|
||||||
- **User integration**: SSH keys are displayed and editable directly on the
|
|
||||||
user form view.
|
|
||||||
- **Access control**: All internal users can view SSH keys; only users with
|
|
||||||
``Settings / Administration`` rights can create, edit, or delete them.
|
|
||||||
|
|
||||||
# Installation
|
|
||||||
|
|
||||||
Use Odoo normal module installation procedure to install
|
|
||||||
``maintenance_user_ssh_key``.
|
|
||||||
|
|
||||||
This module depends on ``base`` and requires no external Python dependencies.
|
|
||||||
|
|
||||||
# Configuration
|
|
||||||
|
|
||||||
No specific configuration is required. After installation:
|
|
||||||
|
|
||||||
1. Go to *Settings > Users & Companies > Users*.
|
|
||||||
2. Open any user and navigate to the **SSH Keys** notebook page.
|
|
||||||
3. Add SSH keys with the public key content.
|
|
||||||
|
|
||||||
# Usage
|
|
||||||
|
|
||||||
## Managing SSH Keys
|
|
||||||
|
|
||||||
- Open a user form and go to the *SSH Keys* tab.
|
|
||||||
- Click **Add a line** and paste the public key content.
|
|
||||||
|
|
||||||
# Bug Tracker
|
|
||||||
|
|
||||||
Bugs are tracked on
|
|
||||||
`our issues website <https://git.elabore.coop/Elabore/maintenance-tools/issues>`_.
|
|
||||||
In case of trouble, please check there if your issue has already been reported.
|
|
||||||
If you spotted it first, help us smashing it by providing a detailed and
|
|
||||||
welcomed feedback.
|
|
||||||
|
|
||||||
# Credits
|
|
||||||
|
|
||||||
## Contributors
|
|
||||||
|
|
||||||
- Stéphan Sainléger
|
|
||||||
|
|
||||||
## Funders
|
|
||||||
|
|
||||||
The development of this module has been financially supported by:
|
|
||||||
|
|
||||||
- Elabore (https://elabore.coop)
|
|
||||||
|
|
||||||
## Maintainer
|
|
||||||
|
|
||||||
This module is maintained by Elabore.
|
|
||||||
@@ -1 +0,0 @@
|
|||||||
from . import models
|
|
||||||
@@ -1,22 +0,0 @@
|
|||||||
# Copyright 2026 Stéphan Sainléger (Elabore)
|
|
||||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
|
||||||
|
|
||||||
{
|
|
||||||
"name": "maintenance_user_ssh_key",
|
|
||||||
"version": "18.0.1.0.0",
|
|
||||||
"author": "Elabore",
|
|
||||||
"website": "https://git.elabore.coop/elabore/maintenance-tools",
|
|
||||||
"maintainer": "Stéphan Sainléger",
|
|
||||||
"license": "AGPL-3",
|
|
||||||
"category": "Tools",
|
|
||||||
"summary": "Manage SSH keys per user.",
|
|
||||||
"depends": ["base"],
|
|
||||||
"data": [
|
|
||||||
"security/ir.model.access.csv",
|
|
||||||
"views/ssh_key_views.xml",
|
|
||||||
"views/res_users_views.xml",
|
|
||||||
],
|
|
||||||
"installable": True,
|
|
||||||
"auto_install": False,
|
|
||||||
"application": False,
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
from . import ssh_key
|
|
||||||
from . import res_users
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
# Copyright 2026 Stéphan Sainléger (Elabore)
|
|
||||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
|
||||||
|
|
||||||
from odoo import fields, models
|
|
||||||
|
|
||||||
|
|
||||||
class ResUsers(models.Model):
|
|
||||||
_inherit = "res.users"
|
|
||||||
|
|
||||||
ssh_key_ids = fields.One2many(
|
|
||||||
comodel_name="ssh.key",
|
|
||||||
inverse_name="user_id",
|
|
||||||
string="SSH Keys",
|
|
||||||
)
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
# Copyright 2026 Stéphan Sainléger (Elabore)
|
|
||||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
|
||||||
|
|
||||||
from odoo import fields, models
|
|
||||||
|
|
||||||
|
|
||||||
class SshKey(models.Model):
|
|
||||||
_name = "ssh.key"
|
|
||||||
_description = "SSH Key"
|
|
||||||
|
|
||||||
key = fields.Text(string="Public Key", required=True)
|
|
||||||
user_id = fields.Many2one(
|
|
||||||
comodel_name="res.users",
|
|
||||||
string="User",
|
|
||||||
required=True,
|
|
||||||
ondelete="cascade",
|
|
||||||
index=True,
|
|
||||||
)
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
id,name,model_id/id,group_id/id,perm_read,perm_write,perm_create,perm_unlink
|
|
||||||
access_ssh_key_user,ssh.key.user,model_ssh_key,base.group_user,1,0,0,0
|
|
||||||
access_ssh_key_manager,ssh.key.manager,model_ssh_key,base.group_system,1,1,1,1
|
|
||||||
|
@@ -1,21 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
|
||||||
<odoo>
|
|
||||||
|
|
||||||
<record id="view_users_form_ssh_key_inherit" model="ir.ui.view">
|
|
||||||
<field name="name">res.users.form.ssh.key</field>
|
|
||||||
<field name="model">res.users</field>
|
|
||||||
<field name="inherit_id" ref="base.view_users_form"/>
|
|
||||||
<field name="arch" type="xml">
|
|
||||||
<xpath expr="//notebook" position="inside">
|
|
||||||
<page string="SSH Keys" name="ssh_keys">
|
|
||||||
<field name="ssh_key_ids">
|
|
||||||
<list editable="top">
|
|
||||||
<field name="key"/>
|
|
||||||
</list>
|
|
||||||
</field>
|
|
||||||
</page>
|
|
||||||
</xpath>
|
|
||||||
</field>
|
|
||||||
</record>
|
|
||||||
|
|
||||||
</odoo>
|
|
||||||
@@ -1,44 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8" ?>
|
|
||||||
<odoo>
|
|
||||||
|
|
||||||
<record id="ssh_key_view_tree" model="ir.ui.view">
|
|
||||||
<field name="name">ssh.key.tree</field>
|
|
||||||
<field name="model">ssh.key</field>
|
|
||||||
<field name="arch" type="xml">
|
|
||||||
<list editable="top">
|
|
||||||
<field name="key"/>
|
|
||||||
<field name="user_id"/>
|
|
||||||
</list>
|
|
||||||
</field>
|
|
||||||
</record>
|
|
||||||
|
|
||||||
<record id="ssh_key_view_form" model="ir.ui.view">
|
|
||||||
<field name="name">ssh.key.form</field>
|
|
||||||
<field name="model">ssh.key</field>
|
|
||||||
<field name="arch" type="xml">
|
|
||||||
<form>
|
|
||||||
<sheet>
|
|
||||||
<group>
|
|
||||||
<field name="user_id"/>
|
|
||||||
</group>
|
|
||||||
<group>
|
|
||||||
<field name="key" nolabel="1"/>
|
|
||||||
</group>
|
|
||||||
</sheet>
|
|
||||||
</form>
|
|
||||||
</field>
|
|
||||||
</record>
|
|
||||||
|
|
||||||
<record id="ssh_key_action" model="ir.actions.act_window">
|
|
||||||
<field name="name">SSH Keys</field>
|
|
||||||
<field name="res_model">ssh.key</field>
|
|
||||||
<field name="view_mode">list,form</field>
|
|
||||||
</record>
|
|
||||||
|
|
||||||
<menuitem
|
|
||||||
id="menu_ssh_key"
|
|
||||||
action="ssh_key_action"
|
|
||||||
parent="base.menu_security"
|
|
||||||
sequence="50"/>
|
|
||||||
|
|
||||||
</odoo>
|
|
||||||
@@ -1,14 +0,0 @@
|
|||||||
/** @type {import('prettier').Config} */
|
|
||||||
|
|
||||||
const config = {
|
|
||||||
// https://github.com/prettier/prettier/issues/15388#issuecomment-1717746872
|
|
||||||
plugins: [require.resolve("@prettier/plugin-xml")],
|
|
||||||
bracketSpacing: false,
|
|
||||||
printWidth: 88,
|
|
||||||
proseWrap: "always",
|
|
||||||
semi: true,
|
|
||||||
trailingComma: "es5",
|
|
||||||
xmlWhitespaceSensitivity: "preserve",
|
|
||||||
};
|
|
||||||
|
|
||||||
module.exports = config;
|
|
||||||
Reference in New Issue
Block a user