CaZzzer/access-controller
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pull dev

Browse Source
This commit is contained in:
Kanris 2021-05-29 23:23:44 +03:00
commit a8221682db
63 changed files with 20565 additions and 648 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
.dockerignore
View File

@ -7,23 +7,25 @@
*.sql.gz
*.sqlite3
.cache
.env
.env*
.project
.idea
.pydevproject
.idea/workspace.xml
.DS_Store
build/
.git/
.sass-cache
.vagrant/
.gitlab/
.gitignore
venv/
fixtures/
db/
data.json
__pycache__
dist
docs
env
logs
src/{{ project_name }}/settings/local.py
src/node_modules
web/media
web/static/CACHE
stats
Dockerfile
docker-compose*
.dockerignore
layouts
staticroot
.editorconfig

10
.env.example
View File

@ -3,8 +3,8 @@ ACTRL_DEBUG=1
ACTRL_SECRET_KEY="v1i_fb\$_jf2#1v_lcsbu&eon4u-os0^px=s^iycegdycqy&5)6"
ACTRL_HOST="actrl.example.com"
ACTRL_EMAIL_HOST="smtp.mail.ru"
ACTRL_EMAIL_PORT=2525
ACTRL_EMAIL_HOST="smtp.gmail.com"
ACTRL_EMAIL_PORT=587
ACTRL_EMAIL_TLS=1
ACTRL_EMAIL_HOST_USER="djgr.02@mail.ru"
ACTRL_EMAIL_HOST_PASSWORD="djangogroup02"
@ -20,6 +20,6 @@ LICENSE_NO=3
SHIFTH=12
ACTRL_ZENDESK_SUBDOMAIN="ngenix1612197338"
ACTRL_API_EMAIL="email@example.com"
ACTRL_API_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
ACTRL_API_PASSWORD=""
ACTRL_API_EMAIL="stepanenko_olga@mail.ru"
ACTRL_API_TOKEN="X1x4QeNa4xRdul2rTIKhac98AsXMwd5bOGAyZOtU"

5
.gitignore vendored
View File

@ -2,6 +2,7 @@
# Created by https://www.toptal.com/developers/gitignore/api/django,pycharm+all,python,linux,macos,windows
# Edit at https://www.toptal.com/developers/gitignore?templates=django,pycharm+all,python,linux,macos,windows
README.rst
### Django ###
*.log
@ -372,4 +373,8 @@ $RECYCLE.BIN/
# Windows shortcuts
*.lnk
### react ###
main/control_page_js_modules/node_modules
static/main/js/control_page/dist
node_modules
# End of https://www.toptal.com/developers/gitignore/api/django,pycharm+all,python,linux,macos,windows

46
.gitlab-ci.yml
View File

@ -1,7 +1,19 @@
image: python:3-alpine
image: python:3.9-alpine
variables:
PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache"
cache:
paths:
- .cache/pip
stages:
- test
- style
- build
- deploy
django_test:
stage: test
@ -21,3 +33,35 @@ coverage:
artifacts:
paths:
- public/coverage
pylint:
stage: style
allow_failure: true
before_script:
- pip install -r requirements/dev.txt
script:
- pylint --reports=yes main
docker:
stage: build
only:
- master
tags:
- docker
before_script:
- docker info
- docker login -u $REGISTRY_USERNAME -p $REGISTRY_PASSWORD gitlab.cazzzer.com:5050
script:
- docker build . -t gitlab.cazzzer.com:5050/cazzzer/zendesk-access-controller:alpine
- docker push gitlab.cazzzer.com:5050/cazzzer/zendesk-access-controller:alpine
after_script:
- docker logout
deploy:
stage: deploy
only:
- master
tags:
- cazzzer-internal
script:
- sudo -u cazzzer /home/cazzzer/deploy_access_controller.sh

627
.pylintrc Normal file
View File

@ -0,0 +1,627 @@
[MASTER]
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code.
extension-pkg-allow-list=
# A comma-separated list of package or module names from where C extensions may
# be loaded. Extensions are loading into the active Python interpreter and may
# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
# for backward compatibility.)
extension-pkg-whitelist=
# Specify a score threshold to be exceeded before program exits with error.
fail-under=10.0
# Files or directories to be skipped. They should be base names, not paths.
ignore=CVS, manage.py
# Files or directories matching the regex patterns are skipped. The regex
# matches against base names, not paths.
ignore-patterns=
# Python code to execute, usually for sys.path manipulation such as
#pygtk.require().
init-hook="from pylint.config import find_pylintrc; import os, sys; sys.path.append(os.path.dirname(find_pylintrc()))"
# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
# number of processors available to use.
jobs=1
# Control the amount of potential inferred values when inferring a single
# object. This can help the performance when dealing with large functions or
# complex, nested conditions.
limit-inference-results=100
# List of plugins (as comma separated values of python module names) to load,
# usually to register additional checkers.
load-plugins=pylint_django
django-settings-module=access_controller.settings
# Pickle collected data for later comparisons.
persistent=yes
# When enabled, pylint would attempt to guess common misconfiguration and emit
# user-friendly hints instead of false-positive error messages.
suggestion-mode=yes
# Allow loading of arbitrary C extensions. Extensions are imported into the
# active Python interpreter and may run arbitrary code.
unsafe-load-any-extension=no
[MESSAGES CONTROL]
# Only show warnings with the listed confidence levels. Leave empty to show
# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
confidence=
# Disable the message, report, category or checker with the given id(s). You
# can either give multiple identifiers separated by comma (,) or put this
# option multiple times (only on the command line, not in the configuration
# file where it should appear only once). You can also use "--disable=all" to
# disable everything first and then reenable specific checks. For example, if
# you want to run only the similarities checker, you can use "--disable=all
# --enable=similarities". If you want to run only the classes checker, but have
# no Warning level messages displayed, use "--disable=all --enable=classes
# --disable=W".
disable=print-statement,
parameter-unpacking,
unpacking-in-except,
old-raise-syntax,
backtick,
long-suffix,
old-ne-operator,
old-octal-literal,
import-star-module-level,
non-ascii-bytes-literal,
raw-checker-failed,
bad-inline-option,
locally-disabled,
file-ignored,
suppressed-message,
useless-suppression,
deprecated-pragma,
use-symbolic-message-instead,
apply-builtin,
basestring-builtin,
buffer-builtin,
cmp-builtin,
coerce-builtin,
execfile-builtin,
file-builtin,
long-builtin,
raw_input-builtin,
reduce-builtin,
standarderror-builtin,
unicode-builtin,
xrange-builtin,
coerce-method,
delslice-method,
getslice-method,
setslice-method,
no-absolute-import,
old-division,
dict-iter-method,
dict-view-method,
next-method-called,
metaclass-assignment,
indexing-exception,
raising-string,
reload-builtin,
oct-method,
hex-method,
nonzero-method,
cmp-method,
input-builtin,
round-builtin,
intern-builtin,
unichr-builtin,
map-builtin-not-iterating,
zip-builtin-not-iterating,
range-builtin-not-iterating,
filter-builtin-not-iterating,
using-cmp-argument,
eq-without-hash,
div-method,
idiv-method,
rdiv-method,
exception-message-attribute,
invalid-str-codec,
sys-max-int,
bad-python3-import,
deprecated-string-function,
deprecated-str-translate-call,
deprecated-itertools-function,
deprecated-types-field,
next-method-defined,
dict-items-not-iterating,
dict-keys-not-iterating,
dict-values-not-iterating,
deprecated-operator-function,
deprecated-urllib-function,
xreadlines-attribute,
deprecated-sys-function,
exception-escape,
comprehension-escape,
# Enable the message, report, category or checker with the given id(s). You can
# either give multiple identifier separated by comma (,) or put this option
# multiple time (only on the command line, not in the configuration file where
# it should appear only once). See also the "--disable" option for examples.
enable=c-extension-no-member
[REPORTS]
# Python expression which should return a score less than or equal to 10. You
# have access to the variables 'error', 'warning', 'refactor', and 'convention'
# which contain the number of messages in each category, as well as 'statement'
# which is the total number of statements analyzed. This score is used by the
# global evaluation report (RP0004).
evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)
# Template used to display messages. This is a python new-style format string
# used to format the message information. See doc for all details.
#msg-template=
# Set the output format. Available formats are text, parseable, colorized, json
# and msvs (visual studio). You can also give a reporter class, e.g.
# mypackage.mymodule.MyReporterClass.
output-format=text
# Tells whether to display a full report or only the messages.
reports=no
# Activate the evaluation score.
score=yes
[REFACTORING]
# Maximum number of nested blocks for function / method body
max-nested-blocks=5
# Complete name of functions that never returns. When checking for
# inconsistent-return-statements if a never returning function is called then
# it will be considered as an explicit return statement and no message will be
# printed.
never-returning-functions=sys.exit,argparse.parse_error
[BASIC]
# Naming style matching correct argument names.
argument-naming-style=snake_case
# Regular expression matching correct argument names. Overrides argument-
# naming-style.
#argument-rgx=
# Naming style matching correct attribute names.
attr-naming-style=snake_case
# Regular expression matching correct attribute names. Overrides attr-naming-
# style.
#attr-rgx=
# Bad variable names which should always be refused, separated by a comma.
bad-names=foo,
bar,
baz,
toto,
tutu,
tata
# Bad variable names regexes, separated by a comma. If names match any regex,
# they will always be refused
bad-names-rgxs=
# Naming style matching correct class attribute names.
class-attribute-naming-style=any
# Regular expression matching correct class attribute names. Overrides class-
# attribute-naming-style.
#class-attribute-rgx=
# Naming style matching correct class constant names.
class-const-naming-style=UPPER_CASE
# Regular expression matching correct class constant names. Overrides class-
# const-naming-style.
#class-const-rgx=
# Naming style matching correct class names.
class-naming-style=PascalCase
# Regular expression matching correct class names. Overrides class-naming-
# style.
#class-rgx=
# Naming style matching correct constant names.
const-naming-style=UPPER_CASE
# Regular expression matching correct constant names. Overrides const-naming-
# style.
#const-rgx=
# Minimum line length for functions/classes that require docstrings, shorter
# ones are exempt.
docstring-min-length=-1
# Naming style matching correct function names.
function-naming-style=snake_case
# Regular expression matching correct function names. Overrides function-
# naming-style.
#function-rgx=
# Good variable names which should always be accepted, separated by a comma.
good-names=i,
id,
e,
n,
j,
k,
ex,
Run,
_
# Good variable names regexes, separated by a comma. If names match any regex,
# they will always be accepted
good-names-rgxs=
# Include a hint for the correct naming format with invalid-name.
include-naming-hint=no
# Naming style matching correct inline iteration names.
inlinevar-naming-style=any
# Regular expression matching correct inline iteration names. Overrides
# inlinevar-naming-style.
#inlinevar-rgx=
# Naming style matching correct method names.
method-naming-style=snake_case
# Regular expression matching correct method names. Overrides method-naming-
# style.
#method-rgx=
# Naming style matching correct module names.
module-naming-style=snake_case
# Regular expression matching correct module names. Overrides module-naming-
# style.
#module-rgx=
# Colon-delimited sets of names that determine each other's naming style when
# the name regexes allow several styles.
name-group=
# Regular expression which should only match function or class names that do
# not require a docstring.
no-docstring-rgx=^_
# List of decorators that produce properties, such as abc.abstractproperty. Add
# to this list to register other decorators that produce valid properties.
# These decorators are taken in consideration only for invalid-name.
property-classes=abc.abstractproperty
# Naming style matching correct variable names.
variable-naming-style=snake_case
# Regular expression matching correct variable names. Overrides variable-
# naming-style.
#variable-rgx=
[FORMAT]
# Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
expected-line-ending-format=
# Regexp for a line that is allowed to be longer than the limit.
ignore-long-lines=^\s*(# )?<?https?://\S+>?$
# Number of spaces of indent required inside a hanging or continued line.
indent-after-paren=4
# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1
# tab).
indent-string=' '
# Maximum number of characters on a single line.
max-line-length=120
# Maximum number of lines in a module.
max-module-lines=1000
# Allow the body of a class to be on the same line as the declaration if body
# contains single statement.
single-line-class-stmt=no
# Allow the body of an if to be on the same line as the test if there is no
# else.
single-line-if-stmt=no
[TYPECHECK]
# List of decorators that produce context managers, such as
# contextlib.contextmanager. Add to this list to register other decorators that
# produce valid context managers.
contextmanager-decorators=contextlib.contextmanager
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E1101 when accessed. Python regular
# expressions are accepted.
generated-members=
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# Tells whether to warn about missing members when the owner of the attribute
# is inferred to be None.
ignore-none=yes
# This flag controls whether pylint should warn about no-member and similar
# checks whenever an opaque object is returned when inferring. The inference
# can return multiple potential results while evaluating a Python object, but
# some branches might not be evaluated, which results in partial inference. In
# that case, it might be useful to still emit no-member and other checks for
# the rest of the inferred objects.
ignore-on-opaque-inference=yes
# List of class names for which member attributes should not be checked (useful
# for classes with dynamically set attributes). This supports the use of
# qualified names.
ignored-classes=optparse.Values,thread._local,_thread._local
# List of module names for which member attributes should not be checked
# (useful for modules/projects where namespaces are manipulated during runtime
# and thus existing member attributes cannot be deduced by static analysis). It
# supports qualified module names, as well as Unix pattern matching.
ignored-modules=
# Show a hint with possible names when a member name was not found. The aspect
# of finding the hint is based on edit distance.
missing-member-hint=yes
# The minimum edit distance a name should have in order to be considered a
# similar match for a missing member name.
missing-member-hint-distance=1
# The total number of similar names that should be taken in consideration when
# showing a hint for a missing member.
missing-member-max-choices=1
# List of decorators that change the signature of a decorated function.
signature-mutators=
[STRING]
# This flag controls whether inconsistent-quotes generates a warning when the
# character used as a quote delimiter is used inconsistently within a module.
check-quote-consistency=no
# This flag controls whether the implicit-str-concat should generate a warning
# on implicit string concatenation in sequences defined over several lines.
check-str-concat-over-line-jumps=no
[SIMILARITIES]
# Ignore comments when computing similarities.
ignore-comments=yes
# Ignore docstrings when computing similarities.
ignore-docstrings=yes
# Ignore imports when computing similarities.
ignore-imports=no
# Minimum lines number of a similarity.
min-similarity-lines=4
[MISCELLANEOUS]
# List of note tags to take in consideration, separated by a comma.
notes=FIXME,
XXX,
TODO
# Regular expression of note tags to take in consideration.
#notes-rgx=
[LOGGING]
# The type of string formatting that logging methods do. `old` means using %
# formatting, `new` is for `{}` formatting.
logging-format-style=old
# Logging modules to check that the string format arguments are in logging
# function parameter format.
logging-modules=logging
[VARIABLES]
# List of additional names supposed to be defined in builtins. Remember that
# you should avoid defining new builtins when possible.
additional-builtins=
# Tells whether unused global variables should be treated as a violation.
allow-global-unused-variables=yes
# List of names allowed to shadow builtins
allowed-redefined-builtins=
# List of strings which can identify a callback function by name. A callback
# name must start or end with one of those strings.
callbacks=cb_,
_cb
# A regular expression matching the name of dummy variables (i.e. expected to
# not be used).
dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
# Argument names that match this expression will be ignored. Default to name
# with leading underscore.
ignored-argument-names=_.*|^ignored_|^unused_
# Tells whether we should check for unused import in __init__ files.
init-import=no
# List of qualified module names which can have objects that can redefine
# builtins.
redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
[SPELLING]
# Limits count of emitted suggestions for spelling mistakes.
max-spelling-suggestions=4
# Spelling dictionary name. Available dictionaries: en (aspell), en_AU
# (aspell), en_CA (aspell), en_GB (aspell), en_US (aspell), fr_CA (myspell),
# fr_MC (myspell), fr_CH (myspell), fr_LU (myspell), fr_FR (myspell), fr_BE
# (myspell), de_DE (myspell), es_VE (myspell), es_MX (myspell), es_CL
# (myspell), es_CR (myspell), es_US (myspell), it_CH (myspell), pt_BR
# (myspell), es_DO (myspell), en_ZA (myspell), es_PY (myspell), es_GT
# (myspell), es_CU (myspell), es_SV (myspell), es_PE (myspell), es_CO
# (myspell), de_CH (myspell), ru_RU (myspell), es_NI (myspell), es_ES
# (myspell), es_HN (myspell), it_IT (myspell), pt_PT (myspell), de_DE_frami
# (myspell), es_AR (myspell), de_CH_frami (myspell), es_PR (myspell), es_UY
# (myspell), de_AT_frami (myspell), de_AT (myspell), es_PA (myspell), fr
# (myspell), es_EC (myspell), es_BO (myspell).
spelling-dict=
# List of comma separated words that should be considered directives if they
# appear and the beginning of a comment and should not be checked.
spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
# List of comma separated words that should not be checked.
spelling-ignore-words=
# A path to a file that contains the private dictionary; one word per line.
spelling-private-dict-file=
# Tells whether to store unknown words to the private dictionary (see the
# --spelling-private-dict-file option) instead of raising a message.
spelling-store-unknown-words=no
[DESIGN]
# Maximum number of arguments for function / method.
max-args=5
# Maximum number of attributes for a class (see R0902).
max-attributes=10
# Maximum number of boolean expressions in an if statement (see R0916).
max-bool-expr=5
# Maximum number of branch for function / method body.
max-branches=12
# Maximum number of locals for function / method body.
max-locals=15
# Maximum number of parents for a class (see R0901).
max-parents=10
# Maximum number of public methods for a class (see R0904).
max-public-methods=20
# Maximum number of return / yield for function / method body.
max-returns=6
# Maximum number of statements in function / method body.
max-statements=50
# Minimum number of public methods for a class (see R0903).
min-public-methods=2
[IMPORTS]
# List of modules that can be imported at any level, not just the top level
# one.
allow-any-import-level=
# Allow wildcard imports from modules that define __all__.
allow-wildcard-with-all=no
# Analyse import fallback blocks. This can be used to support both Python 2 and
# 3 compatible code, which means that the block might have code that exists
# only in one or another interpreter, leading to false positives when analysed.
analyse-fallback-blocks=no
# Deprecated modules which should not be used, separated by a comma.
deprecated-modules=optparse,tkinter.tix
# Output a graph (.gv or any supported image format) of external dependencies
# to the given file (report RP0402 must not be disabled).
ext-import-graph=
# Output a graph (.gv or any supported image format) of all (i.e. internal and
# external) dependencies to the given file (report RP0402 must not be
# disabled).
import-graph=
# Output a graph (.gv or any supported image format) of internal dependencies
# to the given file (report RP0402 must not be disabled).
int-import-graph=
# Force import order to recognize a module as part of the standard
# compatibility libraries.
known-standard-library=
# Force import order to recognize a module as part of a third party library.
known-third-party=enchant
# Couples of modules and preferred modules, separated by a comma.
preferred-modules=
[CLASSES]
# Warn about protected attribute access inside special methods
check-protected-access-in-special-methods=no
# List of method names used to declare (i.e. assign) instance attributes.
defining-attr-methods=__init__,
__new__,
setUp,
__post_init__
# List of member names, which should be excluded from the protected access
# warning.
exclude-protected=_asdict,
_fields,
_replace,
_source,
_make
# List of valid names for the first argument in a class method.
valid-classmethod-first-arg=cls
# List of valid names for the first argument in a metaclass class method.
valid-metaclass-classmethod-first-arg=cls
[EXCEPTIONS]
# Exceptions that will emit a warning when being caught. Defaults to
# "BaseException, Exception".
overgeneral-exceptions=BaseException,
Exception

32
Dockerfile
View File

@ -1,10 +1,26 @@
FROM python:3.6
COPY ./ /access_controller
FROM python:3.9 as builder
# enchant dependency for sphinx
RUN apt-get update && apt-get install -y python-enchant
# copy source files
WORKDIR /access_controller/
RUN pip install -r requirements/prod.txt
RUN python manage.py makemigrations
COPY ./ /access_controller
# dev requirements for building sphinx docs
RUN pip install -r requirements/dev.txt -r requirements/prod.txt
# build static and documentation files into build/webserver
RUN ./manage.py collectstatic --no-input && ./documentation.sh
# create production venv to copy to final image
# production venv is built here because `cryptography` requires rust which doesn't ship on alpine
RUN python -m venv venv && venv/bin/pip install -r requirements/prod.txt
# move files necessary to run the app to the build folder (including production venv)
RUN mv venv access_controller main manage.py build
FROM python:3.9-alpine
WORKDIR /access_controller/
COPY --from=builder ["/access_controller/build", "./"]
RUN apk update && apk add postgresql-libs && adduser -D -H -u 5579 actrl && chmod -R -w ./
USER actrl
EXPOSE 8000
COPY start.sh /var/
CMD bash /var/start.sh
CMD . venv/bin/activate && \
python manage.py migrate && \
cp -rT webserver srv && \
daphne -b 0.0.0.0 access_controller.asgi:application

58
README.md
View File

@ -1,5 +1,3 @@
# ZenDesk Access Controller
## Управление правами доступа
Идея - написать программу(Web приложение), которая будет выдавать права пользователям системы по запросу самого
@ -39,10 +37,19 @@
## Quickstart
Перед запуском требуется неообходимо `.env` файл.
Перед запуском необходимо создать `.env` файл.
```bash
cp .env.example .env
```
Установить модули для работы js
```bash
sudo apt install npm
cd main/control_page_js_modules/
npm install
sudo npm -g install npx
npx webpack
```
Заменить переменные в `.env` на актуальные.
```bash
sudo apt install make
@ -59,6 +66,26 @@ pip install -r requirements/dev.txt
Для админов ZenDesk дополнительно - создайте токен доступа в ZenDesk
При запуске в Docker убедитесь что папка, которая будет служить хранилищем для БД, открыта на запись и чтение
Для запуска тестов страницы управления:
1. Установить npm и npx
```bash
sudo apt install npm
```
2. Перейти в static папку со страницей управления:
```bash
cd main/control_page_js_modules/
```
3. Выполнить установку модулей для js
```bash
npm install
sudo npm -g install npx
npx webpack
```
4. Тестирование в той же папке
```bash
npm test
```
## Запуск на локальной машине:
- Скопировать репозиторий на локальную машину
@ -71,7 +98,7 @@ pip install -r requirements/dev.txt
```
ACTRL_DEBUG={0/1} - включить режим дебага
ACTRL_HOST={HOSTNAME} - при запуске без дебага, надо указать домен на котором будет работать приложение
ACTRL_SECRET_KEY={DJANGO_SECRET_KEY} - секретный ключ сгенерированый Django
ACTRL_SECRET_KEY={DJANGO_SECRET_KEY} - секретный ключ сгенерированный Django
ACTRL_EMAIL_HOST={SMTP_HOST} - домен почтового сервера через который приложение будет отправлять письма, например "smtp.gmail.com"
ACTRL_EMAIL_PORT={SMTP_PORT} - порт для почтового сервера, например 587, 465 , 2525
@ -133,7 +160,7 @@ docker run -d -p 8000:8000 \
-v {ABSOLUTE_PATH_TO_DB}:/zendesk-access-controller/db \
access_controller:latest
```
- открываем запущеный контейнер в браузере (можно перейти по ссылке http://localhost:8000/)
- открываем запущенный контейнер в браузере (можно перейти по ссылке http://localhost:8000/)
## Запуск с тестовыми юзерами:
@ -144,12 +171,31 @@ docker run -d -p 8000:8000 \
- Пользователь - `123@test.ru` / `zendeskuser`
Не сработает если домен песочницы отличается от `ngenix1612197338` (на другом домене нужно будет создать сначала пользователей в песочнице с правами админа и легкого агента
с этими же почтами, назначить им организацию `SYSTEM`)
с этими же email, назначить им организацию `SYSTEM`)
## Параметры тестовой песочницы:
Пример полной конфигурации можно найти в [.env.example](.env.example). Почту и токен админа ZenDesk взять у руководителя (если вы не админ).
## Для проверки pylint используем:
```bash
pylint main
```
## Для приведения файлов к стандарту PEP8 используем:
```bash
autopep8 --in-place filename
```
##Для проверки орфографии:
```bash
cd docs
make spelling
```
##Для обновления документации:
```bash
./documentation.sh
```
## Read more
- Zenpy: [http://docs.facetoe.com.au](http://docs.facetoe.com.au)

0
README.rst Normal file
View File

5
access_controller/asgi.py
View File

@ -8,10 +8,7 @@ https://docs.djangoproject.com/en/3.1/howto/deployment/asgi/
"""
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'access_controller.settings')
from django.core.asgi import get_asgi_application
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'access_controller.settings')
application = get_asgi_application()

22
access_controller/auth.py
View File

@ -1,19 +1,31 @@
"""
Авторизация пользователя.
"""
from django.contrib.auth.backends import ModelBackend
from django.contrib.auth.models import User
from django.contrib.auth import get_user_model
class EmailAuthBackend(ModelBackend):
"""
Класс авторизации пользователя по email.
"""
def authenticate(self, request, username=None, password=None, **kwargs):
"""
Функция получения пользователя (модель User) по email.
"""
try:
user = User.objects.get(email=username)
user = get_user_model().objects.get(email=username)
if user.check_password(password):
return user
return None
except User.DoesNotExist:
except get_user_model().DoesNotExist:
return None
def get_user(self, user_id):
"""
Функция получения пользователя по id.
"""
try:
return User.objects.get(pk=user_id)
except User.DoesNotExist:
return get_user_model().objects.get(pk=user_id)
except get_user_model().DoesNotExist:
return None

47
access_controller/settings.py
View File

@ -10,6 +10,7 @@ For the full list of settings and their values, see
https://docs.djangoproject.com/en/3.1/ref/settings/
"""
import os
from pathlib import Path
from dotenv import load_dotenv
@ -26,7 +27,7 @@ load_dotenv()
SECRET_KEY = os.getenv('ACTRL_SECRET_KEY', 'empty')
# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = bool(int(os.getenv('ACTRL_DEBUG', 1)))
DEBUG = bool(int(os.getenv('ACTRL_DEBUG', '0')))
ALLOWED_HOSTS = [
'127.0.0.1',
@ -62,8 +63,8 @@ ROOT_URLCONF = 'access_controller.urls'
EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST = os.getenv('ACTRL_EMAIL_HOST', 'smtp.gmail.com')
EMAIL_PORT = int(os.getenv('ACTRL_EMAIL_PORT', 587))
EMAIL_USE_TLS = bool(int(os.getenv('ACTRL_EMAIL_TLS', 1)))
EMAIL_PORT = int(os.getenv('ACTRL_EMAIL_PORT', '587'))
EMAIL_USE_TLS = bool(int(os.getenv('ACTRL_EMAIL_TLS', '1')))
EMAIL_HOST_USER = os.getenv('ACTRL_EMAIL_HOST_USER', 'group02django@gmail.com')
EMAIL_HOST_PASSWORD = os.getenv('ACTRL_EMAIL_HOST_PASSWORD', 'djangogroup02')
DEFAULT_FROM_EMAIL = os.getenv('ACTRL_FROM_EMAIL', EMAIL_HOST_USER)
@ -91,13 +92,24 @@ WSGI_APPLICATION = 'access_controller.wsgi.application'
# Database
# https://docs.djangoproject.com/en/3.1/ref/settings/#databases
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db' / 'zd_db.sqlite3'
if DEBUG:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': BASE_DIR / 'db' / 'zd_db.sqlite3'
}
}
else:
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': os.getenv('ACTRL_DB_NAME'),
'USER': os.getenv('ACTRL_DB_USER'),
'PASSWORD': os.getenv('ACTRL_DB_PASSWORD'),
'HOST': os.getenv('ACTRL_DB_HOST'),
'PORT': os.getenv('ACTRL_DB_PORT'),
}
}
}
# Password validation
# https://docs.djangoproject.com/en/3.1/ref/settings/#auth-password-validators
@ -134,16 +146,21 @@ USE_TZ = True
# https://docs.djangoproject.com/en/3.1/howto/static-files/
STATIC_URL = '/static/'
STATIC_ROOT = os.path.join(BASE_DIR, 'staticroot')
STATIC_ROOT = BASE_DIR / 'build' / 'webserver' / 'static'
STATICFILES_DIRS = [
os.path.join(BASE_DIR, 'static'),
]
STATICFILES_FINDERS = [
'django.contrib.staticfiles.finders.FileSystemFinder',
'django.contrib.staticfiles.finders.AppDirectoriesFinder',
]
ACCOUNT_ACTIVATION_DAYS = 7
LOGIN_REDIRECT_URL = '/'
LOGOUT_REDIRECT_URL = '/'
# Название_приложения.Название_файла.Название_класса_обработчика
AUTHENTICATION_BACKENDS = [
'access_controller.auth.EmailAuthBackend',
@ -154,8 +171,8 @@ AUTHENTICATION_BACKENDS = [
ZENDESK_ROLES = {
'engineer': int(os.getenv('ENG_CROLE_ID', 0)),
'light_agent': int(os.getenv('LA_CROLE_ID', 0)),
'engineer': int(os.getenv('ENG_CROLE_ID', '0')),
'light_agent': int(os.getenv('LA_CROLE_ID', '0')),
}
ZENDESK_GROUPS = {
@ -165,7 +182,7 @@ ZENDESK_GROUPS = {
SOLVED_TICKETS_EMAIL = os.getenv('ST_EMAIL')
ZENDESK_MAX_AGENTS = int(os.getenv('LICENSE_NO', 0))
ZENDESK_MAX_AGENTS = int(os.getenv('LICENSE_NO', '0'))
REST_FRAMEWORK = {
# Use Django's standard `django.contrib.auth` permissions,
@ -175,6 +192,7 @@ REST_FRAMEWORK = {
]
}
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
ONE_DAY = int(os.getenv('SHIFTH', 0)) # Количество часов в 1 рабочем дне
@ -183,3 +201,6 @@ ACTRL_ZENDESK_SUBDOMAIN = os.getenv('ACTRL_ZENDESK_SUBDOMAIN') or os.getenv('ZD_
ACTRL_API_EMAIL = os.getenv('ACTRL_API_EMAIL') or os.getenv('ACCESS_CONTROLLER_API_EMAIL')
ACTRL_API_TOKEN = os.getenv('ACTRL_API_TOKEN') or os.getenv('ACCESS_CONTROLLER_API_TOKEN')
ACTRL_API_PASSWORD = os.getenv('ACTRL_API_PASSWORD') or os.getenv('ACCESS_CONTROLLER_API_PASSWORD')
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

3
access_controller/urls.py
View File

@ -31,7 +31,7 @@ urlpatterns = [
path('accounts/register/error/', registration_error, name='registration_email_error'),
path('accounts/login/', CustomLoginView.as_view(), name='login'),
path('accounts/', include('django.contrib.auth.urls')),
path('work/<int:id>', work_page, name="work"),
path('work/<int:required_id>', work_page, name="work"),
path('work/hand_over/', work_hand_over, name="work_hand_over"),
path('work/become_engineer/', work_become_engineer, name="work_become_engineer"),
path('work/get_tickets', work_get_tickets, name='work_get_tickets'),
@ -39,6 +39,7 @@ urlpatterns = [
path('registration_failed/', registration_failed, name='registration_failed'),
path('control/', AdminPageView.as_view(), name='control'),
path('statistic/', statistic_page, name='statistic'),
]
# Django REST

5
data.json
View File

@ -22,8 +22,9 @@
"pk": 1,
"fields": {
"name": "ZendeskAdmin",
"user": 1,
"role": "admin"
"user": 3,
"role": "admin",
"user_id": 1
}
},
{

35
docker-compose.yml Normal file
View File

@ -0,0 +1,35 @@
version: '3.8'
services:
web:
image: gitlab.cazzzer.com:5050/cazzzer/zendesk-access-controller:alpine
env_file:
- .env.prod
volumes:
- static:/access_controller/srv
expose:
- 8000
depends_on:
- db
db:
image: postgres:13-alpine
volumes:
- postgres_data:/var/lib/postgresql/data/
expose:
- 5432
env_file:
- .env.prod.db
nginx:
build: ./nginx
volumes:
- static:/srv/access_controller
ports:
- 8004:80
depends_on:
- web
volumes:
postgres_data:
static:

BIN
docs/source/_static/statistic.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 91 KiB

BIN
docs/source/_static/take_tickets.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 72 KiB

32
docs/source/code.rst
View File

@ -6,7 +6,7 @@ Models
*******
.. automodule:: main.models
:members:
:members:
******
@ -41,3 +41,33 @@ Views
:members:
*****************
Обработка тикетов
*****************
.. automodule:: main.requester
:members:
*********************
Обработка статистики
*********************
.. automodule:: main.statistic_data
:members:
*********************************
Функционал администратора Zendesk
*********************************
.. automodule:: main.zendesk_admin
:members:
********
Тесты
********
.. automodule:: main.tests
:members:

54
docs/source/conf.py
View File

@ -11,17 +11,17 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sphinx.events
import sys
import importlib
import inspect
import enchant
from enchant import checker
import django
sphinx.events.core_events['autodoc-process-signature'] = ''
sys.path.insert(0, os.path.abspath('../../'))
import django
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'access_controller.settings')
os.environ.setdefault('DJANGO_CONFIGURATION', 'Dev')
@ -39,7 +39,6 @@ from django.db.models.query import QuerySet
QuerySet.__repr__ = lambda self: self.__class__.__name__
django.setup()
# -- Project information -----------------------------------------------------
@ -52,6 +51,8 @@ author = 'SHP S101, group 2'
release = 'v0.01'
# -- General configuration ---------------------------------------------------
def process_django_models(app, what, name, obj, options, lines):
@ -89,6 +90,7 @@ def process_django_models(app, what, name, obj, options, lines):
lines.append(':type %s: %s.%s' % (field.attname, module, field_type.__name__))
if enchant is not None:
lines += spelling_white_list
lines.append('')
return lines
@ -116,13 +118,18 @@ def skip_queryset(app, what, name, obj, skip, options):
return skip
# def setup(app):
# # Register the docstring processor with sphinx
# app.connect('autodoc-process-docstring', process_django_models)
# app.connect('autodoc-skip-member', skip_queryset)
# app.connect('autodoc-process-docstring', process_modules)
def process_signature(app, what: str, name: str, obj, options, signature, return_annotation):
if not callable(obj):
return
def setup(app):
# Register the docstring processor with sphinx
app.connect('autodoc-process-docstring', process_django_models)
app.connect('autodoc-skip-member', skip_queryset)
app.connect('autodoc-process-docstring', process_modules)
app.connect("autodoc-process-signature", process_signature)
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@ -132,16 +139,13 @@ extensions = {
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx_rtd_theme',
'sphinx.ext.graphviz',
'sphinx.ext.inheritance_diagram',
'sphinx_autodoc_typehints',
'sphinxcontrib.spelling'
'sphinxcontrib.spelling',
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@ -171,6 +175,7 @@ html_static_path = ['_static']
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
@ -183,20 +188,21 @@ intersphinx_mapping = {
}
autodoc_default_flags = ['members']
autodoc_typehints = "description"
# spell checking
spelling_lang = 'ru_RU'
tokenizer_lang = 'ru_RU'
spelling_exclude_patterns=['ignored_*']
tokenizer_lang = 'en_US'
spelling_exclude_patterns = ['ignored_*', '../../main/models.py']
spelling_show_suggestions = True
spelling_show_whole_line=True
spelling_warning=True
spelling_show_whole_line = True
spelling_warning = True
spelling_ignore_pypi_package_names = True
spelling_ignore_wiki_words=True
spelling_ignore_acronyms=True
spelling_ignore_python_builtins=True
spelling_ignore_importable_modules=True
spelling_ignore_contributor_names=True
spelling_ignore_wiki_words = True
spelling_ignore_acronyms = True
spelling_ignore_python_builtins = True
spelling_ignore_importable_modules = True
spelling_ignore_contributor_names = True
# -- Options for todo extension ----------------------------------------------
@ -206,5 +212,3 @@ set_type_checking_flag = True
typehints_fully_qualified = True
always_document_param_types = True
typehints_document_rtype = True
napoleon_attr_annotations = True

1
docs/source/index.rst
View File

@ -12,6 +12,7 @@
overview
code
readme
todo

32
docs/source/overview.rst
View File

@ -69,24 +69,33 @@
Запрос прав доступа
********************
На странице запроса прав Вам доступна информация о количестве и списке работающих над тикетами сотрудников,
а также возможность сдать и запросить права.
На странице запроса прав Вам доступна информация о количестве и списке работающих над тикетами сотрудников.
Если Вы не являетесь инженером, то на данной странице Вы можете запросить права.
Если Вы являетесь инженером, то права можно сдать.
.. image:: _static/request.png
Успешное изменение прав:
Успешное изменение прав - список инженеров пополнился новым пользователем:
.. image:: _static/role_change.png
Являясь инженером, Вы можете запросить в работу необходимое количество тикетов.
.. image:: _static/take_tickets.png
Назначенные тикеты будут доступны в Zendesk.
******************************************
Управление правами доступа администратором
******************************************
Для администратора существует удобный интерфейс страницы управления, в котором представлены:
* Количество свободных инженерных мест
* Количество и список инженеров и легких агентов
* Возможность группового назначения прав с использованием чек-боксов
* количество свободных инженерных мест
* количество и список инженеров и легких агентов
* возможность группового назначения прав с использованием чекбоксов
.. image:: _static/admin_manage.png
@ -94,4 +103,13 @@
.. image:: _static/admin_manage_done.png
.. |copy| unicode:: 0xA9 .. Школа программистов S101, группа 2. 2021гю
Вы можете смотреть статистику работы пользователя.
Для этого на странице статистика необходимо указать:
* email пользователя
* период, за который необходима статистика
* формат отображения данных
.. image:: _static/statistic.png
.. |copy| unicode:: 0xA9 .. Школа программистов S101, группа 2. 2021г.

4
docs/source/readme.rst Normal file
View File

@ -0,0 +1,4 @@
READ.me
==================
.. include:: ../../README.rst

168
docs/source/spelling_wordlist.txt
View File

@ -45,7 +45,9 @@ start
end
date
Токен
токен
токеном
токену
аутентифицирован
(datetime.time)
datetime
@ -81,8 +83,166 @@ functions
Serializer
Serializers
Сериализатор
Сериализаторы
сериализатор
сериализатора
переадресации
чекбоксов
админских
админские
Python
Docker
докер
докера
Докер
репозиторий
zendesk-access-controller/db
-e
-v
e
v
zendesk
db
юзерами
Read
Zenpy
залогинен
т
д
rolchangelogs
извеcтно
role
View
Model
type
param
rtype
return
UsersViewSet
list
engineers
agents
request
rest
framework
response
Сэндбокс
админскими
логирование
code
block
d
p
ACTRL_DEBUG
дебага
ACTRL_HOST
HOSTNAME
ACTRL_SECRET_KEY
DJANGO_SECRET_KEY
ACTRL_EMAIL_HOST
SMTP_HOST
smtp.gmail.com
ACTRL_EMAIL_PORT
SMTP_PORT
ACTRL_EMAIL_TLS
USE_TLS
TLS
ACTRL_EMAIL_HOST_USER
USERNAME
ACTRL_EMAIL_HOST_PASSWORD
PASSWORD
ACTRL_FROM_EMAIL
EMAIL
ACTRL_SERVER_EMAIL
ACTRL_API_EMAIL
ACTRL_API_PASSWORD
ACTRL_API_TOKEN
API_TOKEN
ACTRL_ZENDESK_SUBDOMAIN
DOMAIN
ENG_CROLE_ID
ENGINEER_CUSTOM_ROLE_ID
custom_role_id
LA_CROLE_ID
LIGHT_AGENT_CUSTOM_ROLE_ID
EMPL_GROUP
EMPLOYEE_GROUP_NAME
ССКС
BUF_GROUP
BUFFER_GROUP_NAME
буферной
тикетами
ST_EMAIL
SOLVED_TICKETS_EMAIL
LICENSE_NO
LICENSE_NO
SHIFTH
SHIFT_HOURS
ABSOLUTE
ABSOLUTE_PATH_TO_DB
PATH
TO
DB
latest
in
place
cd
docs
a
Аватарка
filename
work
form
work_get_tickets
get
tickets
Do
takes
whatever
it
to
actually
log
the
specified
logging
record
This
version
is
intended
be
implemented
by
subclasses
so
new
тикеты
StatisticForm
patch
zenpy
Mock
редирект
редиректа
предустановки
TicketListRequester
get_tickets_list_for_user
side
effect
for
залогиненный
предустанавливает
переадресация
фикстуры
profile
json
аватарки
аватарке
locmem
бэкенд
has
control
disallowed
test
users
Contents

23
documentation.sh Executable file
View File

@ -0,0 +1,23 @@
#!/usr/bin/env sh
retry() {
retries=$1
shift
count=0
until "$@"; do
exit=$?
count=$((count + 1))
if [ $count -lt $retries ]; then
echo "Retry $count/$retries exited $exit, retrying..."
else
echo "Retry $count/$retries exited $exit, no more retries left."
return $exit
fi
done
return 0
}
m2r README.md --overwrite
sphinx-build -b html docs/source build/webserver/docs
rm README.rst

7
main/admin.py
View File

@ -1,3 +1,8 @@
from django.contrib import admin
"""
Встроенный файл
"""
# from django.contrib import admin
# Register your models here.

0
main/apiauth.py Normal file
View File

6
main/apps.py
View File

@ -1,5 +1,11 @@
"""
Стандартный файл Django конфигурации приложения.
"""
from django.apps import AppConfig
class MainConfig(AppConfig):
"""
Старт приложения
"""
name = 'main'

8
main/control_page_js_modules/.babelrc Normal file
View File

@ -0,0 +1,8 @@
{
"presets": ["@babel/preset-env", "@babel/preset-react"],
"plugins": [
["@babel/plugin-transform-runtime", {
"regenerator": true
}], "@babel/plugin-syntax-jsx"
]
}

98
main/control_page_js_modules/__tests__/control.test.js Normal file
View File

@ -0,0 +1,98 @@
import React from "react";
import {render, unmountComponentAtNode} from "react-dom";
import {act} from "react-dom/test-utils";
import {Table} from "../src/control";
import * as test_data from "./test_users.json"
import axios from "axios";
import MockAdapter from "axios-mock-adapter";
let mock = null
let container = null
beforeEach(() => {
mock = new MockAdapter(axios);
mock.onGet('/api/users').reply(200, test_data)
container = document.createElement('div')
container.id = "table"
document.body.appendChild(container)
})
afterEach(() => {
unmountComponentAtNode(container);
mock.restore()
container.remove();
container = null;
});
it("has no rows without axios request", () => {
act(() => {
render(<Table/>, container);
});
let tbody = container.querySelector("#tbody")
expect(tbody.getElementsByTagName('tr').length).toBe(0);
});
it("shows valid number of free workplaces", async () => {
await act(async () => {
render(<Table/>, container)
})
let element = container.querySelector('#licences_remaining')
let licences = Number(element.innerHTML.replace(/Свободных мест: /, ''))
expect(licences).toEqual(1)
});
it("Pretext must be deleted on render", () => {
act(() => {
render(<Table/>, container)
})
expect(document.body).not.toContain(container.querySelector('#loading'))
});
it("has valid number of table rows with axios request", async () => {
await act(async () => {
render(<Table/>, container)
})
let tbody = container.querySelector("#tbody")
expect(tbody.getElementsByTagName('tr').length)
.toEqual(test_data.users.length + test_data.zendesk_users.length)
});
it("show valid number for engineers and light agents", async () => {
await act(async () => {
render(<Table/>, container)
})
let engineers = container.querySelector('#engineers')
let agents = container.querySelector('#agents')
expect(Number(engineers.textContent)).toEqual(test_data.engineers)
expect(Number(agents.textContent)).toEqual(test_data.light_agents)
});
it("called one request on mount", async () => {
let requests = jest.spyOn(Table.prototype, "getUsers")
await act(async () => {
render(<Table/>, container)
})
expect(requests).toHaveBeenCalledTimes(1)
requests.mockRestore()
})
it("checkbox count equals users from db count", async () => {
await act(async () => {
render(<Table/>, container)
})
let tbody = container.querySelector("#tbody")
let checkboxes = tbody.querySelectorAll("input[type='checkbox']")
let users = test_data.users
expect(checkboxes.length).toEqual(users.length)
})
it("requests occur every one minute", async () => {
jest.useFakeTimers()
let requests = jest.spyOn(Table.prototype, "getUsers")
await act(async () => {
render(<Table/>, container)
})
jest.advanceTimersByTime(60000)
expect(requests).toHaveBeenCalledTimes(2)
jest.useRealTimers()
requests.mockRestore()
})

32
main/control_page_js_modules/__tests__/test_users.json Normal file
View File

@ -0,0 +1,32 @@
{
"users": [
{
"user": {
"email": "123@test.ru"
},
"id": 2,
"name": "UserForAccessTest",
"zendesk_role": "light_agent"
}
],
"engineers": 2,
"light_agents": 2,
"zendesk_users": [
{
"name": "Степаненко Ольга s101",
"zendesk_role": "engineer",
"email": "stepanenko_olga@mail.ru"
},
{
"name": "TEST",
"zendesk_role": "engineer",
"email": "akovalev1305@gmail.com"
},
{
"name": "Vasua",
"zendesk_role": "light_agent",
"email": "krav-88@mail.ru"
}
],
"max_agents": 3
}

9
main/control_page_js_modules/jest.config.js Normal file
View File

@ -0,0 +1,9 @@
module.exports = {
verbose: true,
testPathIgnorePatterns: [
"./node_modules/"
],
roots: [
"./__tests__"
],
}

17600
main/control_page_js_modules/package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

28
main/control_page_js_modules/package.json Normal file
View File

@ -0,0 +1,28 @@
{
"name": "control_page",
"version": "1.0.0",
"description": "",
"main": "../static/main/js/control_page/dist/index_bundle.js",
"scripts": {
"test": "jest"
},
"author": "",
"license": "ISC",
"dependencies": {
"@babel/cli": "^7.13.16",
"@babel/core": "^7.13.16",
"@babel/plugin-transform-runtime": "^7.13.15",
"@babel/preset-env": "^7.13.15",
"@babel/preset-react": "^7.13.13",
"axios": "^0.21.1",
"axios-mock-adapter": "^1.19.0",
"babel-loader": "^8.2.2",
"jest": "^26.6.3",
"jsx": "^0.9.89",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"save-dev": "0.0.1-security",
"webpack": "^5.36.2",
"webpack-cli": "^4.6.0"
}
}

183
main/control_page_js_modules/src/control.js Normal file
View File

@ -0,0 +1,183 @@
import React from "react";
import axios from "axios";
function FreeWorkplaces(props) {
return (
<div className="new-section">
<p className="row page-description" id="licences_remaining">Свободных мест: {props.count}</p>
</div>
)
}
function WorkersCount(props) {
return (
<div className="row justify-content-center new-section d-flex align-items-center">
<div className="col-5">
<div className="info">
<div className="info-row">
<div className="info-target px-4">Инженеров:</div>
<div className="info-quantity">
<div className="status-circle-small light-green"></div>
<span className="info-quantity-value" id="engineers">{props.engineers}</span>
</div>
</div>
<div className="info-row">
<div className="info-target px-4">Легких агентов:</div>
<div className="info-quantity">
<div className="status-circle-small light-yellow"></div>
<span className="info-quantity-value" id="agents">{props.light_agents}</span>
</div>
</div>
</div>
</div>
<div className="col-5">
<button type="submit" name="engineer" className="btn default-button btn-warning btn-block btn-sm py-3">
Назначить выбранных на роль инженера
</button>
<button type="submit" name="light_agent" className="btn default-button btn-warning btn-block btn-sm py-3">
Назначить выбранных на роль легкого агента
</button>
</div>
</div>
)
}
class ModelUserTableRow extends React.Component {
render() {
return (
<tr className={"table-dark"}>
<td>
<input
type="checkbox"
value={this.props.user.id}
className="form-check-input"
name="users"
/>
</td>
<td>
<a href="#">{this.props.user.name}</a>
</td>
<td>{this.props.user.user.email}</td>
<td>{this.props.user.zendesk_role}</td>
</tr>
);
}
}
class ModelUserTableRows extends React.Component {
render() {
return (
this.props.users.map((user, key) => (
<ModelUserTableRow user={user} key={key} />
))
);
}
}
class ZendeskUserTableRow extends React.Component {
render() {
return (
<tr className={"table-secondary text-secondary"}>
<td></td>
<td>
<a href="#" style={{ color: "grey", fontStyle: "italic" }}>
{this.props.user.name}
</a>
</td>
<td style={{ color: "grey", fontStyle: "italic" }}>
{this.props.user.email}
</td>
<td style={{ color: "grey", fontStyle: "italic" }}>
{this.props.user.zendesk_role}
</td>
</tr>
);
}
}
class ZendeskUserTableRows extends React.Component {
render() {
return (
this.props.users.map((user, key) => (
<ZendeskUserTableRow user={user} key={key} />
))
)
}
}
export class Table extends React.Component {
constructor(props) {
super(props);
this.state = {
users: [],
engineers: null,
light_agents: null,
zendesk_users: [],
max_agents: null,
renderLoad: true
};
}
async getUsers() {
await axios.get("/api/users").then((response) => {
this.setState({
users: response.data.users,
engineers: response.data.engineers,
light_agents: response.data.light_agents,
zendesk_users: response.data.zendesk_users,
max_agents: response.data.max_agents,
renderLoad: false
});
return response
}).catch(reason => {
console.log(reason)
});
}
componentDidMount() {
this.getUsers().then(() => {})
.catch(reason => {
console.log(reason)
});
this.interval = setInterval(() => {
this.getUsers().catch(reason => {
console.log(reason)
})
}, 60000);
}
componentWillUnmount() {
clearInterval(this.interval);
}
render() {
return (
<div>
<FreeWorkplaces count={Math.max(this.state.max_agents - this.state.engineers, 0)}/>
<table className="table table-dark">
<thead>
<tr>
<th>
<input
type="checkbox"
className="form-check-input"
id="head-checkbox"
/>
</th>
<th>Name</th>
<th>Email</th>
<th>Role</th>
</tr>
</thead>
<tbody id="tbody">
<ModelUserTableRows users={this.state.users}/>
<ZendeskUserTableRows users={this.state.zendesk_users}/>
</tbody>
</table>
{this.state.renderLoad === true ? <p id="loading">Данные загружаются...</p> : null}
<WorkersCount engineers={this.state.engineers} light_agents={this.state.light_agents}/>
</div>
);
}
}

17
main/control_page_js_modules/src/index.js Normal file
View File

@ -0,0 +1,17 @@
import {Table} from "./control"
import ReactDOM from "react-dom";
import React from "react";
function headCheckbox() {
let headCheckbox = document.getElementById("head-checkbox");
headCheckbox.addEventListener("click", () => {
let checkboxes = document.getElementsByName("users");
for (let checkbox of checkboxes)
checkbox.checked = headCheckbox.checked;
});
}
ReactDOM.render(<Table />, document.getElementById("table"));
headCheckbox();

31
main/control_page_js_modules/webpack.config.js Normal file
View File

@ -0,0 +1,31 @@
const path = require('path')
module.exports = {
entry: './src/index.js',
module: {
rules: [
{
test: /\.(js)$/,
exclude: path.resolve(__dirname, 'node_modules/'),
use: {
loader: 'babel-loader',
options: {
presets: ['@babel/preset-env', "@babel/preset-react"],
plugins: [["@babel/plugin-transform-runtime", {"regenerator": true}]],
}
}
}
]
},
resolve: {
extensions: [
'.js',
'.jsx'
]
},
output: {
path: path.resolve('../../static/main/js/control_page', 'dist'),
filename: 'index_bundle.js'
},
mode: 'development',
}

164
main/extra_func.py
View File

@ -1,8 +1,16 @@
"""
Вспомогательные функции.
"""
import logging
from datetime import timedelta
from datetime import timedelta, date
from typing import Union, Optional
from django.contrib.auth.models import User
from django.contrib.auth import get_user_model
from django.contrib.auth.models import Permission
from django.contrib.contenttypes.models import ContentType
from django.core.exceptions import ObjectDoesNotExist
from django.core.handlers.wsgi import WSGIRequest
from django.http import HttpResponseRedirect, HttpResponsePermanentRedirect
from django.shortcuts import redirect
from django.utils import timezone
from zenpy import Zenpy
@ -16,14 +24,13 @@ from main.requester import TicketListRequester
from main.zendesk_admin import zenpy
def update_role(user_profile: UserProfile, role: int, who_changes: User) -> None:
def update_role(user_profile: UserProfile, role: int, who_changes: get_user_model()) -> None:
"""
Функция меняет роль пользователя.
:param user_profile: Профиль пользователя
:param role: Новая роль
:param who_changes: Пользователь, меняющий роль
:return: Пользователь с обновленной ролью
"""
zendesk = zenpy
user = zendesk.get_user(user_profile.user.email)
@ -34,7 +41,7 @@ def update_role(user_profile: UserProfile, role: int, who_changes: User) -> None
zendesk.update_user(user)
def make_engineer(user_profile: UserProfile, who_changes: User) -> None:
def make_engineer(user_profile: UserProfile, who_changes: get_user_model()) -> None:
"""
Функция устанавливает пользователю роль инженера.
@ -44,12 +51,13 @@ def make_engineer(user_profile: UserProfile, who_changes: User) -> None:
update_role(user_profile, ROLES['engineer'], who_changes)
def make_light_agent(user_profile: UserProfile, who_changes: User) -> None:
def make_light_agent(user_profile: UserProfile, who_changes: get_user_model()) -> None:
"""
Функция устанавливает пользователю роль легкого агента.
:param user_profile: Профиль пользователя
:return: Вызов функции **update_role** с параметрами: профиль пользователя, роль "light_agent"
:return: Вызов функции **update_role** с параметрами: профиль пользователя, роль "light_agent".
Предварительно снимаем тикеты, находящие в работы у пользователя.
"""
tickets: SearchResultGenerator = get_tickets_list(user_profile.user.email)
ticket: ZenpyTicket
@ -79,7 +87,7 @@ def make_light_agent(user_profile: UserProfile, who_changes: User) -> None:
def get_users_list() -> list:
"""
Функция **get_users_list** возвращает список пользователей Zendesk, относящихся к организации SYSTEM.
Функция возвращает список пользователей Zendesk, относящихся к организации SYSTEM.
"""
zendesk = zenpy
@ -89,28 +97,35 @@ def get_users_list() -> list:
return users
def get_tickets_list(email):
def get_tickets_list(email: str) -> Optional[list]:
"""
Функция возвращает список тикетов пользователя Zendesk
Функция возвращает список тикетов пользователя Zendesk.
:param email: Email пользователя
:return: Список тикетов пользователя
"""
return TicketListRequester().get_tickets_list_for_user(zenpy.get_user(email))
def get_tickets_list_for_group(group_name):
def get_tickets_list_for_group(group_name: str) -> Optional[list]:
"""
Функция возвращает список неназначенных, нерешённых тикетов группы Zendesk
Функция возвращает список не назначенных, не решённых тикетов группы Zendesk.
:param group_name: Название группы пользователя
:return: Список тикетов группы
"""
return TicketListRequester().get_tickets_list_for_group(zenpy.get_group(group_name))
def update_profile(user_profile: UserProfile):
def update_profile(user_profile: UserProfile) -> None:
"""
Функция обновляет профиль пользователя в соответствии с текущим в Zendesk.
Функция обновляет профиль пользователя в БД в соответствии с текущим в Zendesk.
:param user_profile: Профиль пользователя
:return: Обновленный, в соответствие с текущими данными в Zendesk, профиль пользователя
"""
user = zenpy.get_user(user_profile.user.email)
update_permission(user_profile, user)
user_profile.name = user.name
user_profile.role = user.role
user_profile.custom_role_id = user.custom_role_id if user.custom_role_id else 0
@ -118,6 +133,52 @@ def update_profile(user_profile: UserProfile):
user_profile.save()
def update_permission(user_profile: UserProfile, user: ZenpyUser):
"""
Функция обновляет права доступа пользователя в БД.
:param user_profile: Профиль пользователя
:param user: Данные пользователя в Zendesk
"""
if user_profile.role != user.role:
user_profile.role = user.role
user_profile.save()
set_permission(user_profile.user)
del_permission(user_profile.user)
def set_permission(user: get_user_model()) -> None:
"""
Функция дает разрешение на просмотр страница администратора, если пользователь имеет роль admin.
:param user: Авторизованный пользователь (получает разрешение, имея роль "admin")
"""
if user.userprofile.role == 'admin':
content_type = ContentType.objects.get_for_model(UserProfile)
permission = Permission.objects.get(
codename='has_control_access',
content_type=content_type,
)
user.user_permissions.add(permission)
user.save()
def del_permission(user: get_user_model()) -> None:
"""
Функция забирает разрешение на просмотр страница администратора, если пользователь не имеет роль admin.
:param user: Авторизованный пользователь (теряет разрешение, не имея роль "admin")
"""
if user.userprofile.role == 'agent' and user.has_perm('main.has_control_access'):
content_type = ContentType.objects.get_for_model(UserProfile)
permission = Permission.objects.get(
codename='has_control_access',
content_type=content_type,
)
user.user_permissions.remove(permission)
user.save()
def check_user_exist(email: str) -> bool:
"""
Функция проверяет, существует ли пользователь.
@ -142,6 +203,9 @@ def check_user_auth(email: str, password: str) -> bool:
"""
Функция проверяет, верны ли входные данные.
:param email: Email пользователя
:param password: Пароль пользователя
:return: Существует ли пользователь
:raise: :class:`APIException`: исключение, вызываемое если пользователь не аутентифицирован
"""
creds = {
@ -157,14 +221,15 @@ def check_user_auth(email: str, password: str) -> bool:
return True
def update_user_in_model(profile: UserProfile, zendesk_user: ZenpyUser):
def update_user_in_model(profile: UserProfile, zendesk_user: ZenpyUser) -> None:
"""
Функция обновляет профиль пользователя при изменении данных пользователя на Zendesk.
Функция обновляет профиль пользователя в модели при изменении данных пользователя на Zendesk.
:param profile: Профиль пользователя
:param zendesk_user: Данные пользователя в Zendesk
:return: Обновленный профиль пользователя
"""
update_permission(profile, zendesk_user)
profile.name = zendesk_user.name
profile.role = zendesk_user.role
profile.image = zendesk_user.photo['content_url'] if zendesk_user.photo else None
@ -173,9 +238,12 @@ def update_user_in_model(profile: UserProfile, zendesk_user: ZenpyUser):
profile.save()
def count_users(users) -> tuple:
def count_users(users: list) -> tuple:
"""
Функция подсчета количества сотрудников с ролями engineer и light_agent
Функция подсчета количества сотрудников с ролями engineer и light_agent.
:param users: Список пользователей
:return: Количество инженеров, количество light_agents
"""
engineers, light_agents = 0, 0
for user in users:
@ -186,21 +254,21 @@ def count_users(users) -> tuple:
return engineers, light_agents
def update_users_in_model():
def update_users_in_model() -> list:
"""
Обновляет пользователей в модели UserProfile по списку пользователей в организации
Обновляет пользователей в модели UserProfile по списку пользователей в организации.
"""
users = get_users_list()
for user in users:
try:
profile = User.objects.get(email=user.email).userprofile
profile = get_user_model().objects.get(email=user.email).userprofile
update_user_in_model(profile, user)
except ObjectDoesNotExist:
pass
return users
def daterange(start_date, end_date) -> list:
def daterange(start_date: date, end_date: date) -> list:
"""
Функция возвращает список дней с start_date по end_date, исключая правую границу.
@ -214,17 +282,17 @@ def daterange(start_date, end_date) -> list:
return dates
def get_timedelta(log, time=None) -> timedelta:
def get_timedelta(current_log: RoleChangeLogs, time: timedelta = None) -> timedelta:
"""
Функция возвращает объект класса timedelta, который хранит промежуток времени от начала суток до момента,
который находится в log (объект класса RoleChangeLogs) или в time(datetime.time), если введён.
:param log: Лог
:param current_log: Лог
:param time: Время
:return: Сколько времени прошло от начала суток до события
"""
if time is None:
time = log.change_time.time()
time = current_log.change_time.time()
time = timedelta(hours=time.hour, minutes=time.minute, seconds=time.second)
return time
@ -241,10 +309,20 @@ def last_day_of_month(day: int) -> int:
class DatabaseHandler(logging.Handler):
"""
Класс записи изменений ролей в базу данных.
"""
def __init__(self):
logging.Handler.__init__(self)
def emit(self, record):
def emit(self, record: logging.LogRecord) -> None:
"""
Функция записи в базу данных лога с изменением роли пользователя.
:param record: Лог смены роли пользователя
:return: Запись в БД лога по смене роли пользователя с указанием новой и старой роли, а также автора изменения
"""
database = RoleChangeLogs()
users = record.msg
if users[1]:
@ -265,10 +343,20 @@ class DatabaseHandler(logging.Handler):
class CsvFormatter(logging.Formatter):
"""
Класс преобразования смены ролей пользователей в строковый формат.
"""
def __init__(self):
logging.Formatter.__init__(self)
def format(self, record):
def format(self, record: logging.LogRecord) -> str:
"""
Функция форматирует запись смены роли пользователя в строку.
:param record: Лог смены роли пользователя.
:return: Строка с записью смены пользователя.
"""
users = record.msg
if users[1]:
user = users[0]
@ -289,12 +377,12 @@ class CsvFormatter(logging.Formatter):
return msg
def log(user, admin=None):
def log(user: get_user_model(), admin: get_user_model() = None) -> None:
"""
Осуществляет запись логов в базу данных и csv файл
:param admin:
:param user:
:return:
Функция осуществляет запись логов в базу данных и csv файл.
:param admin: Админ, который меняет роль
:param user: Пользователь, которому изменена роль
"""
users = [user, admin]
logger = logging.getLogger('MY_LOGGER')
@ -309,10 +397,16 @@ def log(user, admin=None):
logger.info(users)
def set_session_params_for_work_page(request, count=None, is_confirm=True):
def set_session_params_for_work_page(request: WSGIRequest, count: int = None, is_confirm: bool = True) -> \
Union[HttpResponsePermanentRedirect, HttpResponseRedirect]:
"""
Функция для страницы получения прав
Устанавливает данные сессии о успешности запроса и количестве назначенных тикетов
Функция для страницы получения прав, устанавливает данные сессии о успешности запроса и количестве
назначенных тикетов.
:param request: Получение данных с рабочей страницы пользователя
:param count: Количество запрошенных тикетов
:param is_confirm: Назначены ли тикеты
:return: Перезагрузка страницы "Управление правами" соответствующего пользователя
"""
request.session['is_confirm'] = is_confirm
request.session['count_tickets'] = count

8
main/forms.py
View File

@ -1,3 +1,6 @@
"""
Формы, использующиеся в приложении.
"""
from django import forms
from django.contrib.auth.forms import AuthenticationForm
from django_registration.forms import RegistrationFormUniqueEmail
@ -56,6 +59,8 @@ class CustomAuthenticationForm(AuthenticationForm):
:param username: Поле для ввода email пользователя
:type username: :class:`django.forms.fields.CharField`
:param error_messages: Список ошибок авторизации
:type error_messages: :class:`dict`
"""
username = forms.CharField(
label="Электронная почта",
@ -64,8 +69,7 @@ class CustomAuthenticationForm(AuthenticationForm):
error_messages = {
'invalid_login':
"Пожалуйста, введите правильные электронную почту и пароль. Оба поля "
"могут быть чувствительны к регистру."
,
"могут быть чувствительны к регистру.",
'inactive': "Аккаунт не активен.",
}

18
main/migrations/0018_alter_unassignedticket_ticket_id.py Normal file
View File

@ -0,0 +1,18 @@
# Generated by Django 3.2.3 on 2021-05-20 17:00
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('main', '0017_auto_20210408_1943'),
]
operations = [
migrations.AlterField(
model_name='unassignedticket',
name='ticket_id',
field=models.IntegerField(help_text='Номер тикета, для которого сняли ответственного'),
),
]

48
main/migrations/0019_auto_20210527_1935.py Normal file
View File

@ -0,0 +1,48 @@
# Generated by Django 3.2.3 on 2021-05-27 16:35
from django.db import migrations, models
class Migration(migrations.Migration):
dependencies = [
('main', '0018_alter_unassignedticket_ticket_id'),
]
operations = [
migrations.AlterField(
model_name='rolechangelogs',
name='id',
field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID'),
),
migrations.AlterField(
model_name='rolechangelogs',
name='new_role',
field=models.BigIntegerField(default=0, help_text='Присвоенная роль'),
),
migrations.AlterField(
model_name='rolechangelogs',
name='old_role',
field=models.BigIntegerField(default=0, help_text='Старая роль'),
),
migrations.AlterField(
model_name='unassignedticket',
name='id',
field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID'),
),
migrations.AlterField(
model_name='unassignedticket',
name='status',
field=models.IntegerField(choices=[(0, 'Снят с пользователя, перенесён в буферную группу'), (1, 'Авторство восстановлено'), (2, 'Пока нас не было, тикет был перенесен из буферной группы. Дополнительные действия не требуются'), (3, 'Тикет уже был закрыт. Дополнительные действия не требуются'), (4, 'Тикет решён. Записан на пользователя с почтой SOLVED_TICKETS_EMAIL')], default=0, help_text='Статус тикета'),
),
migrations.AlterField(
model_name='userprofile',
name='custom_role_id',
field=models.BigIntegerField(default=0, help_text='Код роли пользователя'),
),
migrations.AlterField(
model_name='userprofile',
name='id',
field=models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID'),
),
]

71
main/models.py
View File

@ -1,5 +1,8 @@
"""
Модели, использующиеся в приложении.
"""
from django.contrib.auth import get_user_model
from django.db import models
from django.contrib.auth.models import User
from django.db.models.signals import post_save
from django.dispatch import receiver
from django.utils import timezone
@ -10,7 +13,6 @@ from access_controller.settings import ZENDESK_ROLES
class UserProfile(models.Model):
"""
Модель профиля пользователя.
Профиль создается и изменяется при создании и изменении модель User.
"""
@ -19,57 +21,77 @@ class UserProfile(models.Model):
('has_control_access', 'Can view admin page'),
)
user = models.OneToOneField(to=User, on_delete=models.CASCADE, help_text='Пользователь')
user = models.OneToOneField(to=get_user_model(), on_delete=models.CASCADE, help_text='Пользователь')
role = models.CharField(default='None', max_length=100, help_text='Глобальное имя роли пользователя')
custom_role_id = models.IntegerField(default=0, help_text='Код роли пользователя')
custom_role_id = models.BigIntegerField(default=0, help_text='Код роли пользователя')
image = models.URLField(null=True, blank=True, help_text='Аватарка')
name = models.CharField(default='None', max_length=100, help_text='Имя пользователя на нашем сайте')
@property
def zendesk_role(self):
id = self.custom_role_id
def zendesk_role(self) -> str:
"""
Роль пользователя в Zendesk, либо UNDEFINED, если пользователь не найден.
"""
for role, r_id in ZENDESK_ROLES.items():
if r_id == id:
if r_id == self.custom_role_id:
return role
return 'UNDEFINED'
@receiver(post_save, sender=User)
def create_user_profile(sender, instance, created, **kwargs):
@receiver(post_save, sender=get_user_model())
def create_user_profile(instance: get_user_model(), created: bool, **kwargs) -> None:
"""
Функция создания профиля пользователя (Userprofile) при регистрации пользователя.
:param instance: Экземпляр класса User
:param created: Существует ли пользователь
:param kwargs: Параметры
:return: Обновленный список объектов профилей пользователей
"""
if created:
UserProfile.objects.create(user=instance)
@receiver(post_save, sender=User)
def save_user_profile(sender, instance, **kwargs):
@receiver(post_save, sender=get_user_model())
def save_user_profile(instance: get_user_model(), **kwargs) -> None:
"""
Функция записи БД профиля пользователя.
:param instance: Экземпляр класса User
:param kwargs: Параметры
:return: Запись профиля пользователя
"""
instance.userprofile.save()
class RoleChangeLogs(models.Model):
"""
Модель для логирования изменений ролей пользователя.
Модель для логгирования изменений ролей пользователя
"""
user = models.ForeignKey(to=User, on_delete=models.CASCADE, help_text='Пользователь, которому присвоили другую роль')
old_role = models.IntegerField(default=0, help_text='Старая роль')
new_role = models.IntegerField(default=0, help_text='Присвоенная роль')
user = models.ForeignKey(to=get_user_model(), on_delete=models.CASCADE,
help_text='Пользователь, которому присвоили другую роль')
old_role = models.BigIntegerField(default=0, help_text='Старая роль')
new_role = models.BigIntegerField(default=0, help_text='Присвоенная роль')
change_time = models.DateTimeField(default=timezone.now, help_text='Дата и время изменения роли')
changed_by = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='changed_by', help_text='Кем была изменена роль')
changed_by = models.ForeignKey(to=get_user_model(), on_delete=models.CASCADE, related_name='changed_by',
help_text='Кем была изменена роль')
class UnassignedTicketStatus(models.IntegerChoices):
"""
Класс статусов не распределенных тикетов.
Модель статусов не распределенных тикетов.
:param UNASSIGNED: Снят с пользователя, перенесён в буферную группу
:param RESTORED: Авторство восстановлено
:param NOT_FOUND: Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются
:param NOT_FOUND: Пока нас не было, тикет испарился из буферной группы.
Дополнительные действия не требуются
:param CLOSED: Тикет уже был закрыт. Дополнительные действия не требуются
:param SOLVED: Тикет решён. Записан на пользователя с почтой SOLVED_TICKETS_EMAIL
"""
UNASSIGNED = 0, 'Снят с пользователя, перенесён в буферную группу'
RESTORED = 1, 'Авторство восстановлено'
NOT_FOUND = 2, 'Пока нас не было, тикет испарился из буферной группы. Дополнительные действия не требуются'
NOT_FOUND = 2, 'Пока нас не было, тикет был перенесен из ' \
'буферной группы. Дополнительные действия не требуются'
CLOSED = 3, 'Тикет уже был закрыт. Дополнительные действия не требуются'
SOLVED = 4, 'Тикет решён. Записан на пользователя с почтой SOLVED_TICKETS_EMAIL'
@ -78,7 +100,8 @@ class UnassignedTicket(models.Model):
"""
Модель не распределенного тикета.
"""
assignee = models.ForeignKey(to=User, on_delete=models.CASCADE, related_name='tickets', help_text='Пользователь, с которого снят тикет')
ticket_id = models.IntegerField(help_text='Номер тикера, для которого сняли ответственного')
status = models.IntegerField(choices=UnassignedTicketStatus.choices, default=UnassignedTicketStatus.UNASSIGNED, help_text='Статус тикета')
assignee = models.ForeignKey(to=get_user_model(), on_delete=models.CASCADE, related_name='tickets',
help_text='Пользователь, с которого снят тикет')
ticket_id = models.IntegerField(help_text='Номер тикета, для которого сняли ответственного')
status = models.IntegerField(choices=UnassignedTicketStatus.choices, default=UnassignedTicketStatus.UNASSIGNED,
help_text='Статус тикета')

39
main/requester.py
View File

@ -1,3 +1,8 @@
"""
Обработка тикетов, составление списков тикетов для пользователя и группы пользователей.
"""
from typing import Optional
import requests
from zenpy import TicketApi
from zenpy.lib.api_objects import Ticket
@ -6,6 +11,16 @@ from main.zendesk_admin import zenpy
class TicketListRequester:
"""
Класс обработки тикетов.
:param email: Email пользователя
:type display: :class:`str`
:param token_or_password: Токен или пароль
:type display: :class:`str`
:param prefix: Формат строка url страницы Zendesk
:type display: :class:`str`
"""
def __init__(self):
self.email = zenpy.credentials['email']
if zenpy.credentials.get('token'):
@ -15,11 +30,23 @@ class TicketListRequester:
self.token_or_password = zenpy.credentials.get('password')
self.prefix = f'https://{zenpy.credentials.get("subdomain")}.zendesk.com/api/v2/'
def get_tickets_list_for_user(self, zendesk_user):
def get_tickets_list_for_user(self, zendesk_user: zenpy) -> Optional[list]:
"""
Функция получения списка тикетов пользователя Zendesk.
:param zendesk_user: Пользователь Zendesk
:return: Список тикетов, назначенных на данного пользователя в Zendesk
"""
url = self.prefix + f'users/{zendesk_user.id}/tickets/assigned'
return self._get_tickets(url)
def get_tickets_list_for_group(self, group):
def get_tickets_list_for_group(self, group: zenpy) -> Optional[list]:
"""
Функция получения списка тикетов группы пользователей Zendesk.
:param group: Название группы
:return: Список тикетов
"""
url = self.prefix + '/tickets'
all_tickets = self._get_tickets(url)
tickets = list()
@ -28,7 +55,13 @@ class TicketListRequester:
tickets.append(ticket)
return tickets
def _get_tickets(self, url):
def _get_tickets(self, url: str) -> Optional[list]:
"""
Функция получения полного списка тикетов по url.
:param url: Url Zendesk c указанием тикетов, назначенных на пользователя
:return: Список тикетов
"""
response = requests.get(url, auth=(self.email, self.token_or_password))
tickets = []
if response.status_code != 200:

53
main/serializers.py
View File

@ -1,4 +1,7 @@
from django.contrib.auth.models import User
"""
Сериализаторы, используемые в приложении.
"""
from django.contrib.auth import get_user_model
from rest_framework import serializers
from main.models import UserProfile
from access_controller.settings import ZENDESK_ROLES
@ -7,14 +10,28 @@ from access_controller.settings import ZENDESK_ROLES
class UserSerializer(serializers.HyperlinkedModelSerializer):
"""
Класс serializer для модели User.
:param model: Модель, на основании которой создается сериализатор
:type model: :class:`django.contrib.auth.Models`
:param fields: Передаваемые поля
:type email: :class:`list`
"""
class Meta:
model = User
model = get_user_model()
fields = ['email']
class ProfileSerializer(serializers.HyperlinkedModelSerializer):
"""Класс serializer для модели профиля пользователя"""
"""
Класс serializer для модели профиля пользователя.
:param user: Вложенный сериализатор
:type user: :class:`UserSerializer`
:param model: Модель, на основании которой создается сериализатор
:type model: :class:`django.contrib.auth.Models`
:param fields: Передаваемые поля
:type email: :class:`list`
"""
user = UserSerializer()
class Meta:
@ -23,16 +40,36 @@ class ProfileSerializer(serializers.HyperlinkedModelSerializer):
class ZendeskUserSerializer(serializers.Serializer):
"""Класс serializer для объектов пользователей из zenpy"""
"""
Класс serializer для объектов пользователей из Zenpy.
:param name: Имя пользователя
:type name: :class:`str`
:param zendesk_role: Роль из Zendesk
:type zendesk_role: :class:`str`
:param email: Email пользователя
:type email: :class:`str`
"""
name = serializers.CharField()
zendesk_role = serializers.SerializerMethodField('get_zendesk_role')
email = serializers.EmailField()
@staticmethod
def get_zendesk_role(obj):
def get_zendesk_role(obj) -> str:
"""
Функция строкового заполнения поля сериализатора zendesk_role.
:param obj: объект пользователя Zendesk
:return: роль engineer либо light_agent
"""
if obj.custom_role_id == ZENDESK_ROLES['engineer']:
return 'engineer'
elif obj.custom_role_id == ZENDESK_ROLES['light_agent']:
if obj.custom_role_id == ZENDESK_ROLES['light_agent']:
return 'light_agent'
else:
return "empty"
return "empty"
def create(self, validated_data):
pass
def update(self, instance, validated_data):
pass

99
main/statistic_data.py
View File

@ -1,7 +1,13 @@
"""
Обработка статистики.
Обнаруживает факт изменения роли пользователя и вычисляет отработанное на смене время.
"""
from datetime import date, datetime, timedelta
from typing import Optional
from django.contrib.auth.models import User
from django.contrib.auth import get_user_model
from django.utils import timezone
from access_controller.settings import ONE_DAY, ZENDESK_ROLES as ROLES
@ -11,7 +17,7 @@ from main.models import RoleChangeLogs
class StatisticData:
"""
Класс для учета статистики интервалов работы пользователей.
Класс для учета статистики времени работы пользователей.
Передаваемые параметры: start_date, end_date, email, stat.
:param display: Формат отображения времени (часы, минуты)
@ -34,7 +40,7 @@ class StatisticData:
:type statistic: :class:`dict`
"""
def __init__(self, start_date, end_date, user_email, stat=None):
def __init__(self, start_date, end_date, user_email: str, stat=None):
self.display = None
self.interval = None
self.start_date = start_date
@ -50,19 +56,20 @@ class StatisticData:
else:
self.statistic = stat
def get_statistic(self) -> dict:
def get_statistic(self) -> Optional[dict]:
"""
Функция возвращает статистику работы пользователя.
:return: Словарь statistic с применением формата отображения и интервала работы(если они есть). None, если были ошибки при создании.
:return: Словарь statistic с применением формата отображения
и интервала работы (если они есть).
None, если были ошибки при создании.
"""
if self.is_valid_statistic():
stat = self.statistic
stat = self._use_display(stat)
stat = self._use_interval(stat)
return stat
else:
return None
return None
def is_valid_statistic(self) -> bool:
"""
@ -104,8 +111,7 @@ class StatisticData:
"""
if self.is_valid_data():
return self.data
else:
return None
return None
def is_valid_data(self) -> bool:
"""
@ -115,7 +121,7 @@ class StatisticData:
"""
return not self.errors
def _use_display(self, stat: list) -> list:
def _use_display(self, stat: dict) -> dict:
"""
Функция приводит данные к формату отображения.
@ -134,7 +140,9 @@ class StatisticData:
def _use_interval(self, stat: dict) -> dict:
"""
Функция объединяет ключи и значения в соответствии с интервалом работы.
Переупаковка результата в соответствии с указанным временным диапазоном
Сжимает набор дней в месяцы, если указан режим работы "по месяцам"
:param stat: Статистика работы пользователя
:return: Обновленная статистика
@ -170,7 +178,8 @@ class StatisticData:
"""
Функция возвращает логи в диапазоне дат start_date - end_date для пользователя с указанным email.
:return: Данные о смене статусов пользователя. Если пользователь не найден или интервал времени некорректен - ошибку.
:return: Данные о смене статусов пользователя.
Если пользователь не найден или интервал времени некорректен - ошибку.
"""
if not self.check_time():
self.errors += ['Конец диапазона должен быть позже начала диапазона и раньше текущего времени']
@ -178,12 +187,12 @@ class StatisticData:
try:
self.data = RoleChangeLogs.objects.filter(
change_time__range=[self.start_date, self.end_date + timedelta(days=1)],
user=User.objects.get(email=self.email),
user=get_user_model().objects.get(email=self.email),
).order_by('change_time')
except User.DoesNotExist:
except get_user_model().DoesNotExist:
self.errors += ['Пользователь не найден']
def _init_statistic(self) -> dict:
def _init_statistic(self) -> None:
"""
Функция заполняет словарь, в котором ключ - дата, значение - кол-во проработанных в этот день секунд.
@ -192,22 +201,25 @@ class StatisticData:
self.clear_statistic()
if not self.get_data():
self.warnings += ['Не обнаружены изменения роли в данном промежутке']
return None
first_log, last_log = self.data[0], self.data[len(self.data) - 1]
else:
first_log, last_log = self.data[0], self.data[len(self.data) - 1]
if first_log.old_role == ROLES['engineer']:
self.prev_engineer_logic(first_log)
if first_log.old_role == ROLES['engineer']:
self.prev_engineer_logic(first_log)
if last_log.new_role == ROLES['engineer']:
self.post_engineer_logic(last_log)
if last_log.new_role == ROLES['engineer']:
self.post_engineer_logic(last_log)
for log_index in range(len(self.data) - 1):
if self.data[log_index].new_role == ROLES['engineer']:
self.engineer_logic(log_index)
for log_index in range(len(self.data) - 1):
if self.data[log_index].new_role == ROLES['engineer']:
self.engineer_logic(log_index)
def engineer_logic(self, log_index):
def engineer_logic(self, log_index: int) -> None:
"""
Функция обрабатывает основную часть работы инженера
Функция вычисляет время работы инженера.
:param log_index: Индекс текущего лога
:return: Дополняет статистику работы инженера временем между текущим и последующим логом
"""
current_log, next_log = self.data[log_index], self.data[log_index + 1]
if current_log.change_time.date() != next_log.change_time.date():
@ -219,9 +231,14 @@ class StatisticData:
elapsed_time = next_log.change_time - current_log.change_time
self.statistic[current_log.change_time.date()] += elapsed_time.total_seconds()
def post_engineer_logic(self, last_log):
def post_engineer_logic(self, last_log: RoleChangeLogs) -> None:
"""
Функция обрабатывает случай, когда нам изветсно что инженер работал и после диапазона
Обработка случая, в котором инженер не закрыл смену.
В таком случае считается всё время от момента открытия смены до текущего момента.
:param last_log: Последний лог изменения роли, в результате которого пользователь назначен инженером.
:return: Дополняет статистику работы
"""
self.fill_daterange(last_log.change_time.date() + timedelta(days=1), self.end_date + timedelta(days=1))
if last_log.change_time.date() == timezone.now().date():
@ -234,15 +251,25 @@ class StatisticData:
if self.end_date == timezone.now().date():
self.statistic[self.end_date] = get_timedelta(None, timezone.now().time()).total_seconds()
def prev_engineer_logic(self, first_log):
def prev_engineer_logic(self, first_log: RoleChangeLogs) -> None:
"""
Функция обрабатывает случай, когда нам изветсно что инженер начал работу до диапазона
Обработка случая, в котором инженер закрыл смену в отражаемом периоде, а открыл её до этого периода.
В таком случае должен быть учтён только период от начала отображаемого диапазона до закрытия смены.
:param first_log_log: Первый лог в диапазоне, в результате которого пользователь назначен легким агентом.
:return: Дополняет статистику работы
"""
self.fill_daterange(max(User.objects.get(email=self.email).date_joined.date(), self.start_date),
first_log.change_time.date())
self.fill_daterange(
max(
get_user_model().objects.get(email=self.email).date_joined.date(),
self.start_date
),
first_log.change_time.date()
)
self.statistic[first_log.change_time.date()] += get_timedelta(first_log).total_seconds()
def fill_daterange(self, first: date, last: date, val: int = 24 * 3600) -> dict:
def fill_daterange(self, first: date, last: date, val: int = 24 * 3600) -> None:
"""
Функция заполняет диапазон дат значением val (по умолчанию val = кол-во секунд в 1 дне).
@ -253,9 +280,11 @@ class StatisticData:
for day in daterange(first, last):
self.statistic[day] = val
def clear_statistic(self) -> dict:
def clear_statistic(self) -> None:
"""
Функция осуществляет обновление всех дней.
Чистка статистики и установка времени по умолчанию.
Устанавливает время смены в 0
"""
self.statistic.clear()
self.fill_daterange(self.start_date, self.end_date + timedelta(days=1), 0)

4
main/templates/base/base.html
View File

@ -9,6 +9,8 @@
<title>{% block title %}{% endblock %}</title>
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/5.0.0-alpha1/css/bootstrap.min.css"
integrity="sha384-r4NyP46KrjDleawBgD5tp8Y7UzmLA05oM1iAEQ17CSuDqnUK2+k9luXQOfXJCJ4I" crossorigin="anonymous">
<link rel="icon" href="{% static 'main/favs/favicon.ico'%}" type="image/x-icon">
<style>
.bd-placeholder-img {
@ -19,6 +21,8 @@
user-select: none;
}
@media (min-width: 768px) {
.bd-placeholder-img-lg {
font-size: 3.5rem;

5
main/templates/base/menu.html
View File

@ -42,6 +42,8 @@
href="{{ work_url }}">Запрос прав</a>
{% endif %}
<a class="btn btn-secondary" href="{% url 'logout' %}">Выйти</a>
<a class="btn btn-secondary"
href="https://actrl.cazzzer.com/docs/index.html"> Документация</a>
</div>
{% else %}
<div class="btn-group" role="group" aria-label="Basic example" style="margin-right: 9px">
@ -59,6 +61,9 @@
class="btn btn-secondary"
{% endif %}
href="{{ registration_url }}">Зарегистрироваться</a>
{% url 'documentation' as documentation_url %}
<a class="btn btn-secondary"
href="{{ documentation_url }}">Документация</a>
</div>
{% endif %}
</nav>

79
main/templates/pages/adm_ruleset.html
View File

@ -12,22 +12,12 @@
{% endblock %}
{% block extra_scripts %}
<script src="https://unpkg.com/react@17/umd/react.development.js" crossorigin></script>
<script src="https://unpkg.com/react-dom@17/umd/react-dom.development.js" crossorigin></script>
<script src="https://unpkg.com/babel-standalone@6/babel.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/axios/dist/axios.min.js"></script>
<script src="{% static 'main/js/control.js'%}" type="text/babel"></script>
<script src="{% static 'main/js/notifications.js' %}"></script> {# Для #}
<script src="{% static 'modules/notifications/dist/notifications.js' %}"></script> {# Уведомлений #}
{% endblock%}
{% block content %}
<div class="container-md">
<div class="new-section">
<p class="row page-description" id="licences_remaining">Свободных Мест:</p>
</div>
{% for message in messages %}
<script>create_notification('{{message}}','','{{message.tags}}',2000)</script>
{% endfor %}
@ -35,78 +25,21 @@
{% block form %}
<form method="post">
{% csrf_token %}
<div class="row justify-content-center new-section">
<div class="col-10">
<h6 class="table-title">Список сотрудников</h6>
<h3 class="py-4 text-center font-weight-bold mb-0">Список сотрудников</h3>
{% block table %}
<table class="table table-dark light-table">
<thead>
<th>
<input
type="checkbox"
class="form-check-input"
id="head-checkbox"
/>
</th>
<th>Name</th>
<th>Email</th>
<th>Role</th>
</thead>
<tbody id="tbody"></tbody>
</table>
<p id="loading">Данные загружаются...</p>
<div id="table"></div>
{% endblock %}
</div>
</div>
{% block count %}
<div class="row justify-content-center new-section">
<div class="col-5">
<div class="info">
<div class="info-row">
<div class="info-target">Инженеров:</div>
<div class="info-quantity">
<div class="status-circle-small light-green"></div>
<span class="info-quantity-value">{{ engineers }}</span>
</div>
</div>
<div class="info-row">
<div class="info-target">Легких агентов:</div>
<div class="info-quantity">
<div class="status-circle-small light-yellow"></div>
<span class="info-quantity-value">{{ light_agents }}</span>
</div>
</div>
</div>
</div>
{% endblock %}
{% block buttons %}
<div class="col-5">
<button type="submit" name="engineer" class="request-acess-button default-button">
Назначить выбранных на роль инженера
</button>
<button type="submit" name="light_agent" class="hand-over-acess-button default-button">
Назначить выбранных на роль легкого агента
</button>
</div>
{% endblock %}
</div>
</form>
{% endblock %}
</div>
<script src="{% static 'main/js/control_page/dist/index_bundle.js' %}"></script>
{% endblock %}

252
main/templates/pages/documentation.html Normal file
View File

@ -0,0 +1,252 @@
<!DOCTYPE html>
<html class="writer-html5" lang="ru" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Документация контроллера прав доступа &mdash; документация ZenDesk Access Controller v0.01</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/translations.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
<link rel="search" title="Поиск" href="search.html" />
<link rel="next" title="Документация пользователя" href="overview.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> ZenDesk Access Controller
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Документация пользователя</a></li>
<li class="toctree-l1"><a class="reference internal" href="code.html">Документация разработчика</a></li>
<li class="toctree-l1"><a class="reference internal" href="readme.html">READ.me</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">Что необходимо доделать?</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">ZenDesk Access Controller</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Документация контроллера прав доступа</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="id1">
<h1>Документация контроллера прав доступа<a class="headerlink" href="#id1" title="Ссылка на этот заголовок"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Документация пользователя</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id2">Управление правами доступа</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id3">Главная страница</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id4">Регистрация</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id5">Авторизация</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id6">Профиль</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id7">Запрос прав доступа</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id8">Управление правами доступа администратором</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="code.html">Документация разработчика</a><ul>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.forms">Forms</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.extra_func">Extra Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.serializers">Serializers</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.views">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.requester">Обработка тикетов</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.statistic_data">Обработка статистики</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.zendesk_admin">Функционал администратора Zendesk</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.tests">Тесты</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="readme.html">READ.me</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">Что необходимо доделать?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="todo.html#todos">TODOs</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Ссылка на этот заголовок"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="overview.html" class="btn btn-neutral float-right" title="Документация пользователя" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, SHP S101, group 2.
</p>
</div>
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

10
main/templates/pages/profile.html
View File

@ -23,7 +23,7 @@
{% block content %}
<br>
<div class="row px-4 py-4">
<div class="col-auto">
<div class="col-auto px-4 py-4">
<div class="container">
<img
src="{% if profile.image %}{{ profile.image }}{% else %}{% static 'no_avatar.png' %}{% endif %}"
@ -31,7 +31,9 @@
alt="Нет изображения"
>
</div>
<a href="{%url 'password_change' %}">Сменить пароль</a>
<div class="px-3 py-5">
<a href="{%url 'password_change' %}" class="btn btn-info">Сменить пароль</a>
</div>
</div>
<div class="col">
<h4><span class="badge bg-secondary text-light">Имя пользователя</span></h4> <h5><strong>{{ profile.name }}</strong></h5>
@ -44,7 +46,7 @@
{% elif profile.custom_role_id == ZENDESK_ROLES.light_agent %}
<h5><strong>light_agent</strong></h5>
{% else %}
<h5><strong><small class="text-muted">None</small></strong></h5>
<h5><strong><small class="text-muted">Без роли</small></strong></h5>
{% endif %}
</div>
@ -52,7 +54,7 @@
<br>
<div align="center" >
<form action="">
<a href="{% url 'work' profile.user.id %}" class="btn btn-primary btn-lg">Запросить права доступа</a>
<a href="{% url 'work' profile.user.id %}" type="submit" class="btn default-button btn-success btn-lg px-4 py-3">Запросить права доступа</a>
</form>
</div>
{% endblock %}

30
main/templates/pages/statistic.html
View File

@ -7,21 +7,21 @@
{% block heading %} Страницы просмотра статистики{% endblock %}
{% block content%}
<div class="mt-5">
<div class="mt-5 py-4">
<div class="container-fluid" style="font-size:2rem">
<form method="post">
{% csrf_token %}
<div class="row g-3">
<div class="col-auto">
{{ form.email.label }}
<div class="col-auto p-2">
<h4 class="py-1">{{ form.email.label }}</h4>
</div>
<div class="col-auto mt-4">
{{ form.email }}
</div>
</div>
<div class="row g-3 mt-4">
<div class="col-auto">
{{ form.interval.label }}
<div class="col-auto p-2">
<h4 class="py-1">{{ form.interval.label }}</h4>
</div>
<div class="col-auto">
{% for radio in form.interval%}
@ -33,8 +33,8 @@
</div>
</div>
<div class="row g-3 mt-4">
<div class="col-auto">
{{ form.display_format.label }}
<div class="col-auto p-2">
<h4 class="py-1">{{ form.display_format.label }}</h4>
</div>
<div class="col-auto">
{% for radio in form.display_format%}
@ -46,8 +46,8 @@
</div>
</div>
<div class="row g-3 mt-4">
<div class="col-auto">
{{ form.range_start.label}}
<div class="col-auto p-2">
<h4 class="py-1">{{ form.range_start.label}}</h4>
</div>
<div class="col-auto">
<div class='col-sm-7'>
@ -56,8 +56,8 @@
</div>
</div>
<div class="row g-3 mt-4">
<div class="col-auto">
{{ form.range_end.label}}
<div class="col-auto p-2">
<h4 class="py-1">{{ form.range_end.label}}</h4>
</div>
<div class="col-auto">
<div class='col-sm-7'>
@ -65,9 +65,9 @@
</div>
</div>
</div>
<div class="form-row text-center">
<div class="form-row text-center py-5">
<div class="col-12">
<button type="submit" class="btn btn-outline-primary">Посмотреть статистику</button>
<button type="submit" class="btn default-button btn-info py-3 px-5">Посмотреть статистику</button>
</div>
</div>
</form>
@ -88,7 +88,11 @@
<tr>
<td scope="col">&nbsp;</td>
{% for date in log_stats.keys %}
{% if interval == 'days' %}
<td scope="col">{{ date | date:'d.m' }}</td>
{% else %}
<td scope="col">{{ date.1 | date:'F' }}</td>
{% endif %}
{% endfor %}
</tr>
</thead>

123
main/templates/pages/work.html
View File

@ -16,66 +16,73 @@
{% endblock %}
{% block content %}
<div class="container-md">
<div class="new-section">
<p class="row page-description">Свободных Мест: {{ licences_remaining }}</p>
</div>
<p class="row page-description">Свободных Мест: {{ licences_remaining }}</p>
<div class="row justify-content-center new-section">
<div class="col-10">
<h6 class="table-title">Список сотрудников с правами инженера</h6>
<table class="light-table">
<thead>
<th>Email</th>
<th>Name</th>
</thead>
<tbody>
{% for engineer in engineers %}
<tr>
<td>{{ engineer.email }}</td>
<td>{{ engineer.name }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
<div class="row justify-content-center new-section">
<div class="col-5">
<div class="info">
<div class="info-row">
<div class="info-target">инженеров: </div>
<div class="info-quantity">
<div class="status-circle-small light-green"></div>
<span class="info-quantity-value">{{ engineers|length }}</span>
</div>
</div>
<div class="info-row">
<div class="info-target">легких агентов:</div>
<div class="info-quantity">
<div class="status-circle-small light-yellow"></div>
<span class="info-quantity-value">{{ agents|length }}</span>
</div>
</div>
</div>
</div>
<div class="col-5">
<a href="/work/become_engineer" class="request-acess-button default-button">Получить права инженера</a>
<a href="/work/hand_over" class="hand-over-acess-button default-button">Сдать права инженера</a>
</div>
<div class="col-10">
<form method="post" action="{% url 'work_get_tickets' %}">
{% csrf_token %}
{{ get_tickets_form.count_tickets }}
<button type="submit" class="default-button">Взять тикеты в работу</button>
</form>
</div>
{% for message in messages %}
<script>create_notification('{{message}}','','{{message.tags}}',2000)</script>
{% endfor %}
</div>
<div class="row justify-content-center new-section">
<div class="col-10 py-3">
<h3 class="py-4 text-center font-weight-bold">Список сотрудников с правами инженера</h3>
<table class="table table-dark">
<thead>
<th>Email</th>
<th>Name</th>
</thead>
<tbody>
{% for engineer in engineers %}
<tr>
<td>{{ engineer.email }}</td>
<td>{{ engineer.name }}</td>
</tr>
{% endfor %}
</tbody>
</table>
</div>
</div>
<div class="row justify-content-center new-section">
<div class="col-5">
<div class="info">
<div class="info-row">
<div class="info-target px-4"><h6>инженеров:</h6></div>
<div class="info-quantity">
<div class="status-circle-small light-green"></div>
<span class="info-quantity-value">{{ engineers|length }}</span>
</div>
</div>
<div class="info-row">
<div class="info-target px-4"><h6>легких агентов:</h6></div>
<div class="info-quantity">
<div class="status-circle-small light-yellow"></div>
<span class="info-quantity-value">{{ agents|length }}</span>
</div>
</div>
</div>
</div>
<div class="col-5 mb-3 py-1">
<div class="row mb-2">
<div class="col">
<a href="/work/become_engineer" class="btn btn-success btn-block py-3">Получить права инженера</a>
</div>
</div>
<div class="row mb-2 py-1">
<div class="col">
<a href="/work/hand_over" class="btn btn-danger btn-block py-3">Сдать права инженера</a>
</div>
</div>
<form class="row g-3 align-items-center" method="GET" action="/work/get_tickets">
<div class="col-2">
<input class="form-control" type="number" min="1" value="1" name="count_tickets">
</div>
<div class="col-10">
<button type="submit" class="btn default-button btn-warning btn-block btn-sm py-3">Взять тикеты в работу</button>
</div>
</form>
</div>
</div>
{% for message in messages %}
<script>create_notification('{{message}}','','{{message.tags}}',5000)</script>
{% endfor %}
{% endblock %}

2
main/templates/registration/password_reset_form.html
View File

@ -12,7 +12,7 @@
<p>Введте свой e-mail адрес для восстановления пароля.</p>
<form action="." method="post">
{{ form.as_p }}
<p><input class="btn btn-success" type="submit" value="Отпрваить e-mail"></p>
<p><input class="btn btn-success" type="submit" value="Отправить e-mail"></p>
{% csrf_token %}
</form>
{% endblock %}

557
main/tests.py
View File

@ -1,11 +1,17 @@
"""
Тестирование работы программы.
"""
import random
from unittest.mock import patch, Mock
from django.contrib.auth.models import User
from django.contrib.auth import get_user_model
from django.core import mail
from django.http import HttpResponseRedirect
from django.template.loader import render_to_string
from django.test import TestCase, Client
from django.urls import reverse, reverse_lazy
from django.utils import translation, timezone
@ -16,47 +22,112 @@ from main.extra_func import log
class UsersBaseTestCase(TestCase):
"""Базовый класс загружения данных для тестов с пользователями"""
"""
Базовый класс загрузки данных для тестов с пользователями.
Для тестов используются фикстуры тестовых пользователей (test_users.json).
"""
fixtures = ['fixtures/test_users.json']
def setUp(self):
"""Добавление в переменные почт и клиентов для пользователей"""
def setUp(self) -> None:
"""
Функция предустановки значений переменных.
Добавляем email тестовых пользователей и создаем клиентов для тестов.
:param light_agent: email тестового пользователя с правами light_agent
:type light_agent: :class:`str`
:param engineer: email тестового пользователя с правами engineer
:type engineer: :class:`str`
:param admin: email тестового пользователя с правами admin
:type admin: :class:`str`
:param agent_client: клиент, залогиненный как пользователь с email light_agent
:type agent_client: :class:`django.test.client.Client`
:param engineer_client: клиент, залогиненный как пользователь с email engineer
:type engineer_client: :class:`django.test.client.Client`
:param admin_client: клиент, залогиненный как пользователь с email admin
:type admin_client: :class:`django.test.client.Client`
"""
self.light_agent = '123@test.ru'
self.admin = 'admin@gmail.com'
self.engineer = 'customer@example.com'
self.engineer = 'customer@example.com'
self.agent_client = Client()
self.agent_client.force_login(User.objects.get(email=self.light_agent))
self.agent_client.force_login(get_user_model().objects.get(email=self.light_agent))
self.admin_client = Client()
self.admin_client.force_login(User.objects.get(email=self.admin))
self.admin_client.force_login(get_user_model().objects.get(email=self.admin))
self.engineer_client = Client()
self.engineer_client.force_login(User.objects.get(email=self.engineer))
self.engineer_client.force_login(get_user_model().objects.get(email=self.engineer))
class RegistrationTestCase(TestCase):
"""
Класс тестирования регистрации.
Для тестов используются фикстуры с данными пользователей engineer и light_agent (data.json).
"""
fixtures = ['fixtures/data.json']
def setUp(self):
def setUp(self) -> None:
"""
Функция предустановки значений переменных.
Добавляем email тестовых пользователей и создаем клиентов для тестов.
:param email_backend: locmem бэкенд со списком отправленных писем
:type email_backend: :class:`str`
:param any_zendesk_user_email: email пользователя, зарегистрированного на Zendesk
:type any_zendesk_user_email: :class:`str`
:param zendesk_admin_email: email администратора
:type zendesk_admin_email: :class:`str`
:param client: новый клиент
:type client: :class:`django.test.client.Client`
"""
self.email_backend = 'django.core.mail.backends.locmem.EmailBackend'
self.any_zendesk_user_email = 'idar.sokurov.05@mail.ru'
self.zendesk_admin_email = 'idar.sokurov.05@mail.ru'
self.client = Client()
def test_registration_complete_redirect(self):
def test_registration_complete_redirect(self) -> None:
"""
Функция тестирования успешной регистрации пользователя.
Проверяет, что в случае если email пользователя зарегистрирован на Zendesk, была заполнена форма регистрации
и направлено письмо со ссылкой для завершения регистрации, происходит редирект на страницу завершения
регистрации.
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
resp = self.client.post(reverse('registration'), data={'email': self.any_zendesk_user_email})
self.assertRedirects(resp, reverse('password_reset_done'))
def test_registration_fail_redirect(self):
def test_registration_fail_redirect(self) -> None:
"""
Функция тестирования не успешной регистрации пользователя (введен email, не зарегистрированный на Zendesk).
Проверяет, что происходит редирект на страницу "registration disallowed"
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
resp = self.client.post(reverse('registration'), data={'email': self.any_zendesk_user_email + 'asd'})
self.assertRedirects(resp, reverse('django_registration_disallowed'))
def test_registration_user_already_exist(self):
def test_registration_user_already_exist(self) -> None:
"""
Функция тестирования попытки зарегистрироваться, используя email уже зарегистрированного в приложении
пользователя ("123@test.ru").
Проверяет, что пользователь получает сообщение "Этот адрес электронной почты уже используется"
"""
with self.settings(EMAIL_BACKEND=self.email_backend) and translation.override('ru'):
resp = self.client.post(reverse('registration'), data={'email': '123@test.ru'})
self.assertContains(resp, 'Этот адрес электронной почты уже используется', count=1, status_code=200)
def test_registration_send_email(self):
def test_registration_send_email(self) -> None:
"""
Функция тестирования отправки email пользователю при регистрации.
Проверяет отправку уведомления на указанный пользователем адрес, а также содержание письма (заголовка и тела)
через email locmem backend.
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
response: HttpResponseRedirect = \
self.client.post(reverse('registration'), data={'email': self.any_zendesk_user_email})
@ -71,50 +142,99 @@ class RegistrationTestCase(TestCase):
correct_body = render_to_string('registration/password_reset_email.html', email_context, response.request)
self.assertEqual(mail.outbox[0].body, correct_body)
def test_registration_user_creating(self):
def test_registration_user_creating(self) -> None:
"""
Функция тестирования создания пользователя приложения при регистрации.
Проверяет соответствие имени созданного пользователя с именем пользователя в Zendesk
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
self.client.post(reverse('registration'), data={'email': self.any_zendesk_user_email})
user = User.objects.get(email=self.any_zendesk_user_email)
user = get_user_model().objects.get(email=self.any_zendesk_user_email)
zendesk_user = zenpy.get_user(self.any_zendesk_user_email)
self.assertEqual(user.userprofile.name, zendesk_user.name)
def test_permissions_applying(self):
def test_permissions_applying(self) -> None:
"""
Функция тестирования создания администратора и присвоения ему соответствующих прав.
Проверяет, что у созданного пользователя роль "admin" и права "has_control_access".
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
self.client.post(reverse('registration'), data={'email': self.zendesk_admin_email})
user = User.objects.get(email=self.zendesk_admin_email)
user = get_user_model().objects.get(email=self.zendesk_admin_email)
self.assertEqual(user.userprofile.role, 'admin')
self.assertTrue(user.has_perm('main.has_control_access'))
class MakeEngineerTestCase(UsersBaseTestCase):
"""
Класс тестирования присвоения пользователю роли engineer.
В тестах используется @patch('main.extra_func.zenpy') Mock для работы с API Zendesk.
"""
@patch('main.extra_func.zenpy')
def test_become_engineer_redirect(self, _zenpy_mock):
user = User.objects.get(email=self.light_agent)
def test_become_engineer_redirect(self, _zenpy_mock: Mock) -> None:
"""
Функция тестирования редиректа на рабочую страницу тестового пользователя при назначении его инженером.
:param _zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
"""
user = get_user_model().objects.get(email=self.light_agent)
resp = self.agent_client.post(reverse_lazy('work_become_engineer'))
self.assertRedirects(resp, reverse('work', args=[user.id]))
self.assertEqual(resp.status_code, 302)
@patch('main.extra_func.zenpy')
def test_light_agent_make_engineer(self, zenpy_mock):
def test_light_agent_make_engineer(self, zenpy_mock: Mock) -> None:
"""
Функция тестирования назначения легкого агента на роль инженера.
Проверяет установку роли "engineer" в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
"""
self.agent_client.post(reverse_lazy('work_become_engineer'))
self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer'])
@patch('main.extra_func.zenpy')
def test_admin_make_engineer(self, zenpy_mock):
def test_admin_make_engineer(self, zenpy_mock: Mock) -> None:
"""
Функция тестирования назначения администратора на роль инженера.
Проверяет установку роли "engineer" в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
"""
self.admin_client.post(reverse_lazy('work_become_engineer'))
self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer'])
@patch('main.extra_func.zenpy')
def test_engineer_make_engineer(self, zenpy_mock):
def test_engineer_make_engineer(self, zenpy_mock: Mock) -> None:
"""
Функция тестирования назначения инженера на роль инженера.
Проверяет установку роли "engineer" в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
"""
self.engineer_client.post(reverse_lazy('work_become_engineer'))
self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['engineer'])
@patch('main.extra_func.zenpy')
def test_control_page_make_engineer_one(self, zenpy_mock):
def test_control_page_make_engineer_one(self, zenpy_mock: Mock) -> None:
"""
Функция тестирования назначения администратором одного инженера на странице "Управление".
Проверяет обновление администратором роли пользователя с light_agent на engineer.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
"""
self.admin_client.post(
reverse_lazy('control'),
data={'users': [User.objects.get(email=self.light_agent).userprofile.id], 'engineer': 'engineer'}
data={'users': [get_user_model().objects.get(email=self.light_agent).userprofile.id],
'engineer': 'engineer'}
)
call_list = zenpy_mock.update_user.call_args_list
mock_object = call_list[0][0][0]
@ -122,13 +242,20 @@ class MakeEngineerTestCase(UsersBaseTestCase):
self.assertEqual(mock_object.custom_role_id, sets.ZENDESK_ROLES['engineer'])
@patch('main.extra_func.zenpy')
def test_control_page_make_engineer_many(self, zenpy_mock):
def test_control_page_make_engineer_many(self, zenpy_mock: Mock) -> None:
"""
Функция тестирования назначения администратором нескольких инженеров на странице "Управление".
Проверяет обновление администратором ролей двух пользователей с light_agent на engineer.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
"""
self.admin_client.post(
reverse_lazy('control'),
data={
'users': [
User.objects.get(email=self.light_agent).userprofile.id,
User.objects.get(email=self.engineer).userprofile.id,
get_user_model().objects.get(email=self.light_agent).userprofile.id,
get_user_model().objects.get(email=self.engineer).userprofile.id,
],
'engineer': 'engineer'
}
@ -141,18 +268,39 @@ class MakeEngineerTestCase(UsersBaseTestCase):
class MakeLightAgentTestCase(UsersBaseTestCase):
"""
Класс тестирования присвоения пользователю роли light_agent.
В тестах используется @patch('main.extra_func.zenpy') Mock для работы API Zendesk, а также
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]]), предоставляющий пустой
список в качестве списка тикетов пользователя.
"""
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]])
@patch('main.extra_func.zenpy')
def test_hand_over_redirect(self, _zenpy_mock, _user_tickets_mock):
user = User.objects.get(email=self.engineer)
def test_hand_over_redirect(self, _zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования переадресации инженера на рабочую страницу, после сдачи прав.
:param _zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
user = get_user_model().objects.get(email=self.engineer)
resp = self.engineer_client.post(reverse_lazy('work_hand_over'))
self.assertRedirects(resp, reverse('work', args=[user.id]))
self.assertEqual(resp.status_code, 302)
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]])
@patch('main.extra_func.zenpy')
def test_engineer_make_light_agent_no_tickets(self, zenpy_mock, _user_tickets_mock):
def test_engineer_make_light_agent_no_tickets(self, zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования назначения инженера легким агентом, в случае, когда у него в работе нет тикетов.
Проверяет назначение роли light_agent в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
self.engineer_client.post(reverse_lazy('work_hand_over'))
self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent'])
@ -160,7 +308,18 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
[Mock(id=1, status='solved'), Mock(id=2, status='open'), Mock(id=3, status='open')]
])
@patch('main.extra_func.zenpy')
def test_engineer_make_light_agent_with_tickets(self, zenpy_mock, _user_tickets_mock):
def test_engineer_make_light_agent_with_tickets(self, zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования назначения инженера легким агентом, в случае, когда у него в работе есть тикеты.
Для тестирования принимается, что в работе у инженера находится 3 тикета, один в состоянии: решен,
два в состоянии: открыт.
Проверяет распределение тикетов (поместить в решенные или назначить нового ответственного),
а также назначение роли light_agent в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
zenpy_mock.solved_tickets_user_id = Mock()
self.engineer_client.post(reverse_lazy('work_hand_over'))
@ -172,7 +331,15 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]])
@patch('main.extra_func.zenpy')
def test_admin_make_light_agent_no_tickets(self, zenpy_mock, _user_tickets_mock):
def test_admin_make_light_agent_no_tickets(self, zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования назначения администратора на роль легкого агента.
Проверяет назначение роли light_agent в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
self.admin_client.post(reverse_lazy('work_hand_over'))
self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent'])
@ -180,7 +347,18 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
[Mock(id=1, status='solved'), Mock(id=2, status='open'), Mock(id=3, status='open')]
])
@patch('main.extra_func.zenpy')
def test_admin_make_light_agent_with_tickets(self, zenpy_mock, _user_tickets_mock):
def test_admin_make_light_agent_with_tickets(self, zenpy_mock: zenpy, _user_tickets_mock: list) -> None:
"""
Функция тестирования назначения администратора легким агентом, в случае, когда у него в работе есть тикеты.
Для тестирования принимается, что в работе находится 3 тикета, один в состоянии: решен,
два в состоянии: открыт.
Проверяет распределение тикетов (поместить в решенные или назначить нового ответственного),
а также назначение роли light_agent в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
zenpy_mock.solved_tickets_user_id = Mock()
self.admin_client.post(reverse_lazy('work_hand_over'))
@ -192,16 +370,33 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]])
@patch('main.extra_func.zenpy')
def test_light_agent_make_light_agent(self, zenpy_mock, _user_tickets_mock):
def test_light_agent_make_light_agent(self, zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования назначения легкого агента на роль легкого агента.
Проверяет назначение роли light_agent в Zendesk.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
self.agent_client.post(reverse_lazy('work_hand_over'))
self.assertEqual(zenpy_mock.update_user.call_args[0][0].custom_role_id, sets.ZENDESK_ROLES['light_agent'])
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[]])
@patch('main.extra_func.zenpy')
def test_control_page_make_light_agent_one(self, zenpy_mock, _user_tickets_mock):
def test_control_page_make_light_agent_one(self, zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования назначения администратором одного легкого агента на странице "Управление".
Проверяет обновление администратором роли пользователя с engineer на light_agent.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
self.admin_client.post(
reverse_lazy('control'),
data={'users': [User.objects.get(email=self.engineer).userprofile.id], 'light_agent': 'light_agent'}
data={'users': [get_user_model().objects.get(email=self.engineer).userprofile.id],
'light_agent': 'light_agent'}
)
call_list = zenpy_mock.update_user.call_args_list
mock_object = call_list[0][0][0]
@ -210,13 +405,22 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
@patch('main.requester.TicketListRequester.get_tickets_list_for_user', side_effect=[[], []])
@patch('main.extra_func.zenpy')
def test_control_page_make_light_agent_many(self, zenpy_mock, _user_tickets_mock):
def test_control_page_make_light_agent_many(self, zenpy_mock: Mock, _user_tickets_mock: Mock) -> None:
"""
Функция тестирования назначения администратором нескольких легких агентов на странице "Управление".
Проверяет обновление администратором ролей двух пользователей с engineer на light_agent.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param _user_tickets_mock: Mock, заменяющий список тикетов пользователя на пустой список.
"""
self.admin_client.post(
reverse_lazy('control'),
data={
'users': [
User.objects.get(email=self.light_agent).userprofile.id,
User.objects.get(email=self.engineer).userprofile.id,
get_user_model().objects.get(email=self.light_agent).userprofile.id,
get_user_model().objects.get(email=self.engineer).userprofile.id,
],
'light_agent': 'light_agent'
}
@ -229,18 +433,32 @@ class MakeLightAgentTestCase(UsersBaseTestCase):
class PasswordResetTestCase(UsersBaseTestCase):
"""
Класс тестирования сброса пароля.
"""
def setUp(self):
super().setUp()
self.email_backend = 'django.core.mail.backends.locmem.EmailBackend'
def test_redirect(self):
def test_redirect(self) -> None:
"""
Функция тестирования успешной смены пароля.
Проверяется переадресация на страницу завершения смены пароля, в случае, когда пользователь существует и на его
email было направлено письмо для сброса пароля.
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
resp = self.agent_client.post(reverse_lazy('password_reset'), data={'email': self.light_agent})
self.assertRedirects(resp, reverse('password_reset_done'))
self.assertEqual(resp.status_code, 302)
def test_send_email(self):
def test_send_email(self) -> None:
"""
Функция тестирования отправки email для сброса пароля.
Проверяет наличие отправленного письма, и его содержание, сверяет email адресата с email пользователя.
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
response: HttpResponseRedirect = \
self.agent_client.post(reverse_lazy('password_reset'), data={'email': self.light_agent})
@ -255,32 +473,56 @@ class PasswordResetTestCase(UsersBaseTestCase):
correct_body = render_to_string('registration/password_reset_email.html', email_context, response.request)
self.assertEqual(mail.outbox[0].body, correct_body)
def test_email_invalid(self):
def test_email_invalid(self) -> None:
"""
Функция тестирования попытки смены пароля с некорректным email.
Проверяет уведомление пользователя о неверном адресе электронной почты.
"""
with self.settings(EMAIL_BACKEND=self.email_backend) and translation.override('ru'):
resp = self.agent_client.post(reverse_lazy('password_reset'), data={'email': 1})
self.assertContains(resp, 'Введите правильный адрес электронной почты.', count=1, status_code=200)
def test_user_does_not_exist(self):
def test_user_does_not_exist(self) -> None:
"""
Функция тестирования попытки смены пароля с email, который не зарегистрирован.
Проверяет отсутствие отправки письма о смене пароля.
"""
with self.settings(EMAIL_BACKEND=self.email_backend):
resp = self.agent_client.post(reverse_lazy('password_reset'), data={'email': self.light_agent + str(random.random())})
resp = self.agent_client.post(reverse_lazy('password_reset'),
data={'email': self.light_agent + str(random.random())})
self.assertRedirects(resp, reverse('password_reset_done'))
self.assertEqual(resp.status_code, 302)
self.assertEqual(len(mail.outbox), 0)
class PasswordChangeTestCase(UsersBaseTestCase):
"""
Класс тестирования смены пароля.
"""
def setUp(self):
def setUp(self) -> None:
super().setUp()
self.set_password()
def set_password(self):
user: User = User.objects.get(email=self.light_agent)
def set_password(self) -> None:
"""
Функция предустанавливает тестовому пользователю с ролью light_agent пароль 'ImpossiblyHardPassword' и создает
клиента с соответствующими данным для тестирования.
"""
user = get_user_model().objects.get(email=self.light_agent)
user.set_password('ImpossiblyHardPassword')
user.save()
self.agent_client.force_login(User.objects.get(email=self.light_agent))
self.agent_client.force_login(get_user_model().objects.get(email=self.light_agent))
def test_change_successful(self):
def test_change_successful(self) -> None:
"""
Функция тестирования успешной смены пароля.
Проверяет установку нового пароля пользователю при вводе корректных данных: старый пароль, новый пароль
(2 раза).
"""
self.agent_client.post(
reverse_lazy('password_change'),
data={
@ -289,10 +531,15 @@ class PasswordChangeTestCase(UsersBaseTestCase):
'new_password2': 'EasyPassword',
}
)
user = User.objects.get(email=self.light_agent)
user = get_user_model().objects.get(email=self.light_agent)
self.assertTrue(user.check_password('EasyPassword'))
def test_invalid_old_password(self):
def test_invalid_old_password(self) -> None:
"""
Функция тестирования смены пароля, при неверном вводе старого пароля.
Проверяет текст уведомления пользователя 'Ваш старый пароль введен неправильно'.
"""
with translation.override('ru'):
resp = self.agent_client.post(
reverse_lazy('password_change'),
@ -304,7 +551,12 @@ class PasswordChangeTestCase(UsersBaseTestCase):
)
self.assertContains(resp, 'Ваш старый пароль введен неправильно', count=1, status_code=200)
def test_different_new_passwords(self):
def test_different_new_passwords(self) -> None:
"""
Функция тестирования смены пароля, при вводе не совпадающих новых паролей.
Проверяет текст уведомления пользователя 'Введенные пароли не совпадают'.
"""
with translation.override('ru'):
resp = self.agent_client.post(
reverse_lazy('password_change'),
@ -317,6 +569,11 @@ class PasswordChangeTestCase(UsersBaseTestCase):
self.assertContains(resp, 'Введенные пароли не совпадают', count=1, status_code=200)
def test_invalid_new_password1(self):
"""
Функция тестирования попытки смены пароля, когда новый пароль не соответствует требованиям: слишком короткий.
Проверяет текст уведомления пользователя 'Введённый пароль слишком короткий'.
"""
with translation.override('ru'):
resp = self.agent_client.post(
reverse_lazy('password_change'),
@ -328,7 +585,13 @@ class PasswordChangeTestCase(UsersBaseTestCase):
)
self.assertContains(resp, 'Введённый пароль слишком короткий', count=1, status_code=200)
def test_invalid_new_password2(self):
def test_invalid_new_password2(self) -> None:
"""
Функция тестирования попытки смены пароля, когда новый пароль не соответствует требованиям: состоит
только из цифр.
Проверяет текст уведомления пользователя 'Введённый пароль состоит только из цифр'.
"""
with translation.override('ru'):
resp = self.agent_client.post(
reverse_lazy('password_change'),
@ -341,6 +604,12 @@ class PasswordChangeTestCase(UsersBaseTestCase):
self.assertContains(resp, 'Введённый пароль состоит только из цифр', count=1, status_code=200)
def test_invalid_new_password3(self):
"""
Функция тестирования попытки смены пароля, когда новый пароль не соответствует требованиям: аналогичен имени
пользователя.
Проверяет текст уведомления пользователя 'Введённый пароль слишком похож на имя пользователя'.
"""
with translation.override('ru'):
resp = self.agent_client.post(
reverse_lazy('password_change'),
@ -356,25 +625,40 @@ class PasswordChangeTestCase(UsersBaseTestCase):
class GetTicketsTestCase(UsersBaseTestCase):
"""
Класс тестов для проверки функции получения тикетов.
В тестах используются @patch('main.views.zenpy.get_user') и @patch('main.views.zenpy.get_user')
для работы с API Zendesk.
"""
@patch('main.views.zenpy.get_user')
@patch('main.extra_func.zenpy')
def test_redirect(self, _zenpy_mock, get_user_mock):
def test_redirect(self, _zenpy_mock: Mock, get_user_mock: Mock) -> None:
"""
Функция проверки переадресации пользователя на рабочую страницу.
Проверяет редирект на рабочую страницу, в случае, когда пользователь с правами инженера заполняет форму
принятия тикетов в работу.
:param _zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param get_user_mock: Mock объекта zenpy_user.
"""
get_user_mock.return_value = Mock()
user = User.objects.get(email=self.engineer)
user = get_user_model().objects.get(email=self.engineer)
resp = self.engineer_client.post(reverse('work_get_tickets'))
self.assertRedirects(resp, reverse('work', args=[user.id]))
self.assertEqual(resp.status_code, 302)
@patch('main.views.zenpy')
@patch('main.views.get_tickets_list_for_group')
def test_take_one_ticket(self, group_tickets_mock, zenpy_mock):
def test_take_one_ticket(self, group_tickets_mock: Mock, zenpy_mock: Mock) -> None:
"""
Функция проверки назначения одного тикета на engineer.
Проверяет соответствие ответственного за тикет объекта tickets и тестового клиента правами инженера,
направившего запрос на назначение одного тикета.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param group_tickets_mock: Mock списка не назначенных и нерешенных тикетов группы.
"""
group_tickets_mock.return_value = [Mock()]
zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer'])
@ -384,9 +668,15 @@ class GetTicketsTestCase(UsersBaseTestCase):
@patch('main.views.get_tickets_list_for_group')
@patch('main.views.zenpy')
def test_take_many_tickets(self, zenpy_mock, group_tickets_mock):
def test_take_many_tickets(self, zenpy_mock: Mock, group_tickets_mock: Mock) -> None:
"""
Функция проверки назначения нескольких тикетов на engineer.
Проверяет соответствие ответственного за тикеты объекта tickets и тестового клиента правами инженера,
направившего запрос на назначение трех тикетов.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param group_tickets_mock: Mock списка не назначенных и нерешенных тикетов группы.
"""
group_tickets_mock.return_value = [Mock()] * 3
zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer'])
@ -397,9 +687,12 @@ class GetTicketsTestCase(UsersBaseTestCase):
@patch('main.views.zenpy.get_user')
@patch('main.views.zenpy')
def test_light_agent_take_ticket(self, zenpy_mock, get_user_mock):
def test_light_agent_take_ticket(self, zenpy_mock: Mock, get_user_mock: Mock) -> None:
"""
Функция проверки попытки назначения тикета на light_agent.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param get_user_mock: Mock объекта zenpy_user.
"""
get_user_mock.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['light_agent'])
self.agent_client.post(reverse('work_get_tickets'), data={'count_tickets': 3})
@ -408,11 +701,16 @@ class GetTicketsTestCase(UsersBaseTestCase):
@patch('main.views.zenpy')
@patch('main.views.get_tickets_list_for_group')
def test_take_zero_tickets(self, TicketsMock, zenpy_mock):
def test_take_zero_tickets(self, tickets_mock: Mock, zenpy_mock: Mock) -> None:
"""
Функция проверки попытки назначения нуля тикета на engineer.
Функция проверки попытки назначения нулевого количества тикетов.
Проверяет, что список тикетов остался пустым.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param tickets_mock: Mock списка тикетов - возвращает пустой список.
"""
TicketsMock.return_value = [Mock()] * 3
tickets_mock.return_value = [Mock()] * 3
zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer'])
self.engineer_client.post(reverse('work_get_tickets'), data={'count_tickets': 0})
tickets = zenpy_mock.update_tickets.call_args[0][0]
@ -420,9 +718,15 @@ class GetTicketsTestCase(UsersBaseTestCase):
@patch('main.views.get_tickets_list_for_group')
@patch('main.views.zenpy')
def test_take_invalid_count_tickets(self, zenpy_mock, group_tickets_mock):
def test_take_invalid_count_tickets(self, zenpy_mock: Mock, group_tickets_mock: Mock) -> None:
"""
Функция проверки попытки назначения нуля тикетов на engineer.
Функция проверки попытки назначения некорректного количества тикетов (введении в форму назначения тикетов
не числового значения, а строки).
Проверяет, отсутствие списка тикетов.
:param zenpy_mock: Mock объекта zenpy для функций, работающих с API Zendesk.
:param group_tickets_mock: Mock списка не назначенных и нерешенных тикетов группы.
"""
group_tickets_mock.return_value = [Mock()] * 3
zenpy_mock.get_user.return_value = Mock(role='agent', custom_role_id=sets.ZENDESK_ROLES['engineer'])
@ -434,46 +738,69 @@ class GetTicketsTestCase(UsersBaseTestCase):
class ProfileTestCase(TestCase):
"""
Класс тестов для проверки синхронизации профиля пользователя.
Для тестов используются фикстуры тестовых пользователей (profile.json).
"""
fixtures = ['fixtures/profile.json']
def setUp(self):
def setUp(self) -> None:
"""
Предустановленные значения для проведения тестов.
Функция предустановки значений переменных.
Добавляем email тестовых пользователей Zendesk и создаем клиентов для тестов.
:param zendesk_agent_email: email тестового пользователя с правами light_agent
:type zendesk_agent_email: :class:`str`
:param zendesk_admin_email: email тестового пользователя с правами admin
:type zendesk_admin_email: :class:`str`
:param client: клиент, залогиненный как пользователь с email zendesk_agent_email
:type client: :class:`django.test.client.Client`
:param admin_client: клиент, залогиненный как пользователь с zendesk_admin_email
:type admin_client: :class:`django.test.client.Client`
"""
self.zendesk_agent_email = 'krav-88@mail.ru'
self.zendesk_admin_email = 'idar.sokurov.05@mail.ru'
self.client = Client()
self.client.force_login(User.objects.get(email=self.zendesk_agent_email))
self.client.force_login(get_user_model().objects.get(email=self.zendesk_agent_email))
self.admin_client = Client()
self.admin_client.force_login(User.objects.get(email=self.zendesk_admin_email))
self.admin_client.force_login(get_user_model().objects.get(email=self.zendesk_admin_email))
def test_correct_username(self):
def test_correct_username(self) -> None:
"""
Функция проверки синхронизации имени пользователя.
Проверяет соответствие имени пользователя из контекста страницы профиля имени пользователя в Zendesk.
"""
resp = self.client.get(reverse('profile'))
self.assertEqual(resp.context['profile'].name, zenpy.get_user(self.zendesk_agent_email).name)
def test_correct_email(self):
def test_correct_email(self) -> None:
"""
Функция проверки синхронизации почты пользователя.
Проверяет соответствие email пользователя из контекста страницы профиля email пользователя в Zendesk.
"""
resp = self.client.get(reverse('profile'))
self.assertEqual(resp.context['profile'].user.email, zenpy.get_user(self.zendesk_agent_email).email)
def test_correct_role(self):
def test_correct_role(self) -> None:
"""
Функция проверки синхронизации роли пользователя.
Проверяет соответствие роли пользователя из контекста страницы профиля роли пользователя в Zendesk. Проверка
осуществляется на примере администратора и агента.
"""
resp = self.client.get(reverse('profile'))
self.assertEqual(resp.context['profile'].role, zenpy.get_user(self.zendesk_agent_email).role)
resp = self.admin_client.get(reverse('profile'))
self.assertEqual(resp.context['profile'].role, zenpy.get_user(self.zendesk_admin_email).role)
def test_correct_custom_role_id(self):
def test_correct_custom_role_id(self) -> None:
"""
Функция проверки синхронизации рабочей роли пользователя.
Проверяет соответствие id рабочей роли пользователя из контекста страницы профиля id
роли пользователя в Zendesk. Проверка осуществляется на примере администратора и агента.
"""
resp = self.client.get(reverse('profile'))
user = zenpy.get_user(self.zendesk_agent_email)
@ -482,9 +809,11 @@ class ProfileTestCase(TestCase):
user = zenpy.get_user(self.zendesk_admin_email)
self.assertEqual(resp.context['profile'].custom_role_id, user.custom_role_id if user.custom_role_id else 0)
def test_correct_image(self):
def test_correct_image(self) -> None:
"""
Функция проверки синхронизации изображения пользователя.
Проверяет соответствие аватарки пользователя из контекста страницы профиля аватарке пользователя в Zendesk.
"""
resp = self.client.get(reverse('profile'))
user = zenpy.get_user(self.zendesk_agent_email)
@ -492,40 +821,100 @@ class ProfileTestCase(TestCase):
class LoggingTestCase(UsersBaseTestCase):
"""
Класс тестирования процесса логгирования.
"""
def setUp(self):
def setUp(self) -> None:
"""
Функция предустановки значений переменных.
Определяем профили пользователей с разными ролями.
:param admin_profile: профиль тестового пользователя с правами admin
:type admin_profile: :class:`Userprofile`
:param agent_profile: профиль тестового пользователя с правами light_agent
:type agent_profile: :class:`Userprofile`
:param engineer_profile: профиль тестового пользователя с правами engineer
:type engineer_profile: :class:`Userprofile`
"""
super().setUp()
self.admin_profile = User.objects.get(email=self.admin).userprofile
self.agent_profile = User.objects.get(email=self.light_agent).userprofile
self.engineer_profile = User.objects.get(email=self.engineer).userprofile
self.admin_profile = get_user_model().objects.get(email=self.admin).userprofile
self.agent_profile = get_user_model().objects.get(email=self.light_agent).userprofile
self.engineer_profile = get_user_model().objects.get(email=self.engineer).userprofile
@staticmethod
def get_file_output():
file = open('logs/logs.csv', 'r')
file_output = file.readlines()[-1]
file.close()
def get_file_output() -> str:
"""
Получение данных из файла логов.
"""
with open('logs/logs.csv', 'r') as file:
file_output = file.readlines()[-1]
return file_output
def test_engineer_with_admin(self):
def test_engineer_with_admin(self) -> None:
"""
Функция проверки корректной записи лога по смене роли инженера в файл.
Сравнивает запись в файле и созданный лог с переданными значениями профилей инженера и администратора
для смены прав.
"""
log(self.engineer_profile, self.admin_profile)
file_output = self.get_file_output()
self.assertEqual(file_output, f'UserForAccessTest,engineer,'
f'{str(timezone.now().today())[:16]},ZendeskAdmin\n')
def test_engineer_without_admin(self):
def test_engineer_without_admin(self) -> None:
"""
Функция проверки корректной записи лога по смене роли инженера в файл без указания администратора.
Сравнивает запись в файле и созданный лог с переданным значением профиля инженера для смены прав.
"""
log(self.engineer_profile)
file_output = self.get_file_output()
self.assertEqual(file_output, f'UserForAccessTest,engineer,'
f'{str(timezone.now().today())[:16]},UserForAccessTest\n')
def test_light_agent_with_admin(self):
def test_light_agent_with_admin(self) -> None:
"""
Функция проверки корректной записи лога по смене роли агента в файл.
Сравнивает запись в файле и созданный лог с переданными значениями профилей агента и администратора
для смены прав.
"""
log(self.agent_profile, self.admin_profile)
file_output = self.get_file_output()
self.assertEqual(file_output, f'UserForAccessTest,light_agent,'
f'{str(timezone.now().today())[:16]},ZendeskAdmin\n')
def test_light_agent_without_admin(self):
def test_light_agent_without_admin(self) -> None:
"""
Функция проверки корректной записи лога по смене роли агента в файл без указания администратора.
Сравнивает запись в файле и созданный лог с переданным значением профиля агента для смены прав.
"""
log(self.agent_profile)
file_output = self.get_file_output()
self.assertEqual(file_output, f'UserForAccessTest,light_agent,'
f'{str(timezone.now().today())[:16]},UserForAccessTest\n')
class ControlAccessTests(TestCase):
"""
Класс тестов для проверки доступа к странице управления
"""
fixtures = ['fixtures/data.json']
def setUp(self) -> None:
self.User = get_user_model()
self.client = Client()
def test_admin_has_perm(self):
self.client.force_login(self.User.objects.get(email='admin@gmail.com'))
self.response = self.client.get(reverse('control'))
self.assertEqual(self.response.status_code, 200)
def test_engineer_doesnt_have_perm(self):
self.client.force_login(self.User.objects.get(email='123@test.ru'))
self.response = self.client.get(reverse('control'))
self.assertEqual(self.response.status_code, 403)

4
main/urls.py
View File

@ -1,3 +1,7 @@
"""
REST framework adds support for automatic URL routing to Django.
"""
from rest_framework.routers import DefaultRouter
from main.views import UsersViewSet

187
main/views.py
View File

@ -1,10 +1,17 @@
"""
View функции.
"""
from smtplib import SMTPException
from typing import Dict, Any, Optional
from django.contrib import messages
from django.contrib.auth import get_user_model
from django.contrib.auth.decorators import login_required
from django.contrib.auth.forms import PasswordResetForm
from django.contrib.auth.mixins import LoginRequiredMixin, PermissionRequiredMixin
from django.contrib.auth.models import User, Permission
from django.contrib.auth.models import Permission
from django.contrib.auth.tokens import default_token_generator
from django.contrib.auth.views import LoginView
from django.contrib.contenttypes.models import ContentType
@ -15,25 +22,46 @@ from django.shortcuts import render, redirect
from django.urls import reverse_lazy
from django.views.generic import FormView
from django_registration.views import RegistrationView
# Django REST
from rest_framework import viewsets
from rest_framework.response import Response
from access_controller.settings import DEFAULT_FROM_EMAIL, ZENDESK_ROLES, ZENDESK_MAX_AGENTS, ZENDESK_GROUPS
from main.extra_func import check_user_exist, update_profile, get_user_organization, \
make_engineer, make_light_agent, get_users_list, update_users_in_model, count_users, \
set_session_params_for_work_page, get_tickets_list_for_group
from main.forms import AdminPageUsers, CustomRegistrationForm, CustomAuthenticationForm, StatisticForm, \
WorkGetTicketsForm
set_session_params_for_work_page, get_tickets_list_for_group, set_permission
from main.forms import AdminPageUsers, CustomRegistrationForm, CustomAuthenticationForm, \
StatisticForm, WorkGetTicketsForm
from main.serializers import ProfileSerializer, ZendeskUserSerializer
from main.zendesk_admin import zenpy
from .models import UserProfile
from .statistic_data import StatisticData
def setup_context(**kwargs) -> Dict[str, Any]:
"""
Функция добавления в контекст статуса пользователя.
:param profile_lit: True, при создании профиля пользователя, иначе False
:param control_lit: False
:param work_lit: True, при установке пользователю рабочей роли, иначе False
:param registration_lit: True, при регистрации пользователя, иначе False
:param login_lit: True, если пользователь залогинен, иначе False
:param stats_lit: True, при получении пользователем прав администратора (просмотр статистики), иначе False
:return: Контекст (context)
"""
context = {}
for key in ('profile_lit', 'control_lit', 'work_lit', 'registration_lit', 'login_lit', 'stats_lit'):
if key in kwargs:
context.update({key: True})
else:
context.update({key: False})
return context
class CustomRegistrationView(RegistrationView):
"""
Отображение и логика работы страницы регистрации пользователя.
Класс отображения и логики работы страницы регистрации пользователя.
:param form_class: Форма, которую необходимо заполнить для регистрации
:type form_class: :class:`forms.CustomRegistrationForm`
@ -41,9 +69,11 @@ class CustomRegistrationView(RegistrationView):
:type template_name: :class:`str`
:param success_url: Указание пути к html-странице завершения регистрации
:type success_url: :class:`django.utils.functional.lazy.<locals>.__proxy__`
:param is_allowed: Определение зарегистрирован ли пользователь с введенным email на Zendesk и принадлежит ли он к организации SYSTEM
:param is_allowed: Определение зарегистрирован ли пользователь с введенным email на Zendesk и
принадлежит ли он к организации SYSTEM
:type is_allowed: :class:`bool`
"""
extra_context = setup_context(registration_lit=True)
form_class = CustomRegistrationForm
template_name = 'django_registration/registration_form.html'
urls = {
@ -53,16 +83,19 @@ class CustomRegistrationView(RegistrationView):
}
redirect_url = 'done'
def register(self, form: CustomRegistrationForm) -> User:
def register(self, form: CustomRegistrationForm) -> Optional[get_user_model()]:
"""
Функция регистрации пользователя.
1. Ввод email пользователя, указанный на Zendesk
1. Ввод email пользователя, указанный на Zendesk.
2. В случае если пользователь с данным паролем зарегистрирован на Zendesk и относится к организации SYSTEM,
происходит сброс ссылки с установлением пароля на указанный email
происходит сброс ссылки с установлением пароля на указанный email.
3. Создается пользователь class User, а также его профиль.
:param form: Email пользователя на Zendesk
:return: user
:return: User
"""
self.redirect_url = 'done'
if check_user_exist(form.data['email']) and get_user_organization(form.data['email']) == 'SYSTEM':
@ -78,50 +111,44 @@ class CustomRegistrationView(RegistrationView):
'html_email_template_name': None,
'extra_email_context': None,
}
user = User.objects.create_user(
user = get_user_model().objects.create_user(
username=form.data['email'],
email=form.data['email'],
password=User.objects.make_random_password(length=50)
password=get_user_model().objects.make_random_password(length=50)
)
try:
update_profile(user.userprofile)
self.set_permission(user)
set_permission(user)
forms.save(**opts)
return user
except SMTPException:
self.redirect_url = 'email_sending_error'
return None
else:
self.redirect_url = 'email_sending_error'
return None
else:
self.redirect_url = 'invalid_zendesk_email'
return None
@staticmethod
def set_permission(user: User) -> None:
"""
Функция дает разрешение на просмотр страница администратора, если пользователь имеет роль admin.
:param user: авторизованный пользователь (получает разрешение, имея роль "admin")
"""
if user.userprofile.role == 'admin':
content_type = ContentType.objects.get_for_model(UserProfile)
permission = Permission.objects.get(
codename='has_control_access',
content_type=content_type,
)
user.user_permissions.add(permission)
def get_success_url(self, user: User = None):
def get_success_url(self, user: get_user_model() = None) -> Dict:
"""
Функция возвращает url-адрес страницы, куда нужно перейти после успешной/не успешной регистрации.
Используется самой django-registration.
:param user: пользователь, пытающийся зарегистрироваться
:return: адресация на страницу успешной регистрации
:param user: Пользователь, пытающийся зарегистрироваться
:return: Адресация на страницу успешной регистрации
"""
return self.urls[self.redirect_url]
def registration_error(request):
def registration_error(request: WSGIRequest) -> HttpResponse:
"""
Функция отображения страницы ошибки регистрации.
:param request: Регистрация
:return: Адресация на страницу ошибки
"""
return render(request, 'django_registration/registration_error.html')
@ -130,8 +157,8 @@ def profile_page(request: WSGIRequest) -> HttpResponse:
"""
Функция отображения страницы профиля.
:param request: данные пользователя из БД
:return: адресация на страницу пользователя
:param request: Данные пользователя из БД
:return: Адресация на страницу пользователя
"""
user_profile: UserProfile = request.user.userprofile
update_profile(user_profile)
@ -144,16 +171,16 @@ def profile_page(request: WSGIRequest) -> HttpResponse:
@login_required()
def work_page(request: WSGIRequest, id: int) -> HttpResponse:
def work_page(request: WSGIRequest, required_id: int) -> HttpResponse:
"""
Функция отображения страницы "Управления правами" для текущего пользователя (login_required).
:param request: объект пользователя
:param request: Объект пользователя
:param id: id пользователя, используется для динамической адресации
:return: адресация на страницу "Управления правами" (либо на страницу "Авторизации", если id и user.id не совпадают
:return: Адресация на страницу "Управления правами" (либо на страницу "Авторизации", если id и user.id не совпадают
"""
users = get_users_list()
if request.user.id == id:
if request.user.id == required_id:
if request.session.get('is_confirm', None):
messages.success(request, 'Изменения были применены')
elif request.session.get('is_confirm', None) is not None:
@ -184,12 +211,12 @@ def work_page(request: WSGIRequest, id: int) -> HttpResponse:
@login_required()
def work_hand_over(request: WSGIRequest):
def work_hand_over(request: WSGIRequest) -> HttpResponseRedirect:
"""
Функция позволяет текущему пользователю сдать права, а именно сменить в Zendesk роль с "engineer" на "light_agent"
:param request: данные текущего пользователя (login_required)
:return: перезагрузка текущей страницы после выполнения смены роли
:param request: Данные текущего пользователя (login_required)
:return: Перезагрузка текущей страницы после выполнения смены роли
"""
make_light_agent(request.user.userprofile, request.user)
return set_session_params_for_work_page(request)
@ -198,18 +225,24 @@ def work_hand_over(request: WSGIRequest):
@login_required()
def work_become_engineer(request: WSGIRequest) -> HttpResponseRedirect:
"""
Функция позволяет текущему пользователю получить права, а именно сменить в Zendesk роль с "light_agent" на "engineer"
Функция позволяет текущему пользователю получить права, а именно сменить в Zendesk роль с "light_agent"
на "engineer".
:param request: данные текущего пользователя (login_required)
:return: перезагрузка текущей страницы после выполнения смены роли
:param request: Данные текущего пользователя (login_required)
:return: Перезагрузка текущей страницы после выполнения смены роли
"""
make_engineer(request.user.userprofile, request.user)
return set_session_params_for_work_page(request)
@login_required()
def work_get_tickets(request):
def work_get_tickets(request: WSGIRequest) -> HttpResponse:
"""
Функция получения тикетов в работу.
:param request: Запрос на принятие тикетов в работу
:return: Перезагрузка рабочей страницы
"""
zenpy_user = zenpy.get_user(request.user.email)
if request.method == 'POST':
@ -245,6 +278,8 @@ class AdminPageView(LoginRequiredMixin, PermissionRequiredMixin, SuccessMessageM
:type form_class: :class:`forms.AdminPageUsersForm`
:param success_url: Адрес страницы администратора
:type success_url: :class:`HttpResponseRedirect`
:param success_message: Уведомление об изменении прав
:type success_url: :class:`str`
"""
permission_required = 'main.has_control_access'
template_name = 'pages/adm_ruleset.html'
@ -266,7 +301,7 @@ class AdminPageView(LoginRequiredMixin, PermissionRequiredMixin, SuccessMessageM
self.make_light_agents(users)
return super().form_valid(form)
def make_engineers(self, users):
def make_engineers(self, users: list) -> None:
"""
Функция проходит по списку пользователей, проставляя статус "engineer".
@ -276,7 +311,7 @@ class AdminPageView(LoginRequiredMixin, PermissionRequiredMixin, SuccessMessageM
for user in users:
make_engineer(user, self.request.user)
def make_light_agents(self, users):
def make_light_agents(self, users: list) -> None:
"""
Функция проходит по списку пользователей, проставляя статус "light agent".
@ -289,19 +324,38 @@ class AdminPageView(LoginRequiredMixin, PermissionRequiredMixin, SuccessMessageM
class CustomLoginView(LoginView):
"""
Отображение страницы авторизации пользователя
Класс отображения страницы авторизации пользователя.
:param extra_context: Добавление в контекст статус пользователя "залогинен"
:type extra_context: :class:`dict`
:param form_class: Форма страницы авторизации
:type form_class: :class: forms.CustomAuthenticationForm
"""
extra_context = setup_context(login_lit=True)
form_class = CustomAuthenticationForm
class UsersViewSet(viewsets.ReadOnlyModelViewSet):
"""
Класс для получения пользователей с помощью api
Класс для получения пользователей с помощью api.
:param queryset: Список пользователей с ролью 'agent'
:type queryset: :class:`str`
:param serializer_class: Класс сериализатор для модели профиля пользователя
:type serializer_class: :class:`ProfileSerializer`
"""
queryset = UserProfile.objects.filter(role='agent')
serializer_class = ProfileSerializer
def list(self, request, *args, **kwargs):
def list(self, request: WSGIRequest, *args, **kwargs) -> Response:
"""
Функция возвращает список пользователей Zendesk, количество engineers и light-agents.
:param request: Запрос
:param args: Аргументы
:param kwargs: Параметры
:return: Список пользователей
"""
users = update_users_in_model()
count = count_users(users.values)
profiles = UserProfile.objects.filter(role='agent')
@ -316,7 +370,14 @@ class UsersViewSet(viewsets.ReadOnlyModelViewSet):
return Response(res)
@staticmethod
def choose_users(zendesk, model):
def choose_users(zendesk: list, model: list) -> list:
"""
Функция формирует список пользователей, которые не зарегистрированы у нас.
:param zendesk: Список пользователей Zendesk
:param model: Список пользователей (модель Userprofile)
:return: Список
"""
users = []
for zendesk_user in zendesk:
if zendesk_user.name not in [user.name for user in model]:
@ -324,7 +385,13 @@ class UsersViewSet(viewsets.ReadOnlyModelViewSet):
return users
@staticmethod
def get_zendesk_users(users):
def get_zendesk_users(users: list) -> list:
"""
Функция получения списка пользователей Zendesk, не являющихся админами.
:param users: Список пользователей
:return: Список пользователей, не являющимися администраторами.
"""
zendesk_users = ZendeskUserSerializer(
data=[user for user in users if user.role != 'admin'],
many=True
@ -338,8 +405,8 @@ def statistic_page(request: WSGIRequest) -> HttpResponse:
"""
Функция отображения страницы статистики (для "superuser").
:param request: данные о пользователе: email, время и интервал работы. Данные получаем через forms.StatisticForm
:return: адресация на страницу статистики
:param request: Данные о пользователе: email, время и интервал работы. Данные получаем через forms.StatisticForm
:return: Адресация на страницу статистики
"""
# if not request.user.has_perm('main.has_control_access'):
@ -365,11 +432,17 @@ def statistic_page(request: WSGIRequest) -> HttpResponse:
context['errors'] = data.errors
if data.warnings:
context['warnings'] = data.warnings
context['interval'] = data.interval
context['log_stats'] = stats if not context['errors'] else None
elif request.method == 'GET':
form = StatisticForm()
context['form'] = form
return render(request, 'pages/statistic.html', context)
def registration_failed(request):
def registration_failed(request: WSGIRequest) -> HttpResponse:
"""
Функция отображения страницы "Регистрация закрыта".
"""
return render(request, 'pages/registration_failed.html')

30
main/zendesk_admin.py
View File

@ -1,3 +1,7 @@
"""
Функционал работы администратора Zendesk.
"""
from typing import Optional, Dict, List
from zenpy import Zenpy
@ -10,19 +14,25 @@ from access_controller.settings import ACTRL_ZENDESK_SUBDOMAIN, ACTRL_API_EMAIL,
class ZendeskAdmin:
"""
Класс **ZendeskAdmin** существует, чтобы в каждой функции отдельно не проверять аккаунт администратора.
Класс **ZendeskAdmin** содержит описание всего функционала администратора.
:param credentials: Полномочия (первым указывается учетная запись организации в Zendesk)
:type credentials: :class:`Dict[str, str]`
:param admin: Администратор
:type admin: :class:`Zenpy`
:param buffer_group_id: ID буферной группы
:type buffer_group_id: :class:`int`
:param solved_tickets_user_id: ID пользователя, который решил тикет
:type solved_tickets_user_id: :class:`int`
"""
def __init__(self, credentials: Dict[str, str]):
self.credentials = credentials
self.admin = self.create_admin()
self.buffer_group_id: int = self.get_group(ZENDESK_GROUPS['buffer']).id
self.solved_tickets_user_id: int = self.get_user(SOLVED_TICKETS_EMAIL).id
self.buffer_group_id= self.get_group(ZENDESK_GROUPS['buffer']).id
self.solved_tickets_user_id = self.get_user(SOLVED_TICKETS_EMAIL).id
def update_user(self, user: ZenpyUser) -> bool:
def update_user(self, user: ZenpyUser) -> None:
"""
Функция сохраняет изменение пользователя в Zendesk.
@ -30,7 +40,7 @@ class ZendeskAdmin:
"""
self.admin.users.update(user)
def update_tickets(self, tickets: List[ZenpyTicket]):
def update_tickets(self, tickets: List[ZenpyTicket]) -> None:
"""
Функция сохраняет изменение тикетов в Zendesk.
@ -46,7 +56,7 @@ class ZendeskAdmin:
:param email: Email пользователя
:return: Является ли зарегистрированным
"""
return True if self.admin.search(email, type='user') else False
return bool(self.admin.search(email, type='user'))
def get_user(self, email: str) -> ZenpyUser:
"""
@ -69,7 +79,7 @@ class ZendeskAdmin:
return group
return None
def get_user_org(self, email: str) -> str:
def get_user_org(self, email: str) -> Optional[str]:
"""
Функция возвращает организацию, к которой относится пользователь по его email.
@ -86,7 +96,6 @@ class ZendeskAdmin:
:raise: :class:`ValueError`: исключение, вызываемое если email не введен в env
:raise: :class:`APIException`: исключение, вызываемое если пользователя с таким email не существует в Zendesk
"""
if self.credentials.get('email') is None:
raise ValueError('access_controller email not in env')
@ -96,9 +105,8 @@ class ZendeskAdmin:
admin = Zenpy(**self.credentials)
try:
admin.search(self.credentials['email'], type='user')
except APIException:
raise ValueError('invalid access_controller`s login data')
except APIException as invalid_data:
raise ValueError('invalid access_controller`s login data') from invalid_data
return admin

4
nginx/Dockerfile Normal file
View File

@ -0,0 +1,4 @@
FROM nginx:1.21-alpine
RUN rm /etc/nginx/conf.d/default.conf
COPY nginx.conf /etc/nginx/conf.d

21
nginx/nginx.conf Normal file
View File

@ -0,0 +1,21 @@
upstream actrl {
server web:8000;
}
server {
listen 80;
location / {
proxy_pass http://actrl;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Host $host;
proxy_redirect off;
}
location ~ /(static|docs)/ {
root /srv/access_controller/;
autoindex off;
}
}

6
requirements/dev.txt
View File

@ -7,6 +7,12 @@ sphinx-rtd-theme==0.5.2
sphinx-autodoc-typehints==1.12.0
pyenchant==3.2.0
sphinxcontrib-spelling==7.2.1
m2r == 0.2.1
# Tests
coverage==5.5
# Code style
pylint == 2.8.2
pylint-django == 2.4.4
autopep8 == 1.5.6

1
requirements/prod.txt
View File

@ -1,5 +1,6 @@
# Production specific dependencies
-r common.txt
psycopg2==2.8.6
daphne==3.0.2
Twisted[tls,http2]==21.2.0

6
start.sh
View File

@ -1,6 +0,0 @@
cd /access_controller/
python manage.py migrate
python manage.py collectstatic --noinput
daphne -b 0.0.0.0 access_controller.asgi:application

BIN
static/main/favs/favicon.ico Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 318 B

140
static/main/js/control.js
View File

@ -1,140 +0,0 @@
"use strict";
function head_checkbox() {
let head_checkbox = document.getElementById("head-checkbox");
head_checkbox.addEventListener("click", () => {
let checkboxes = document.getElementsByName("users");
for (let checkbox of checkboxes) checkbox.click();
});
}
// React
class ModelUserTableRow extends React.Component {
render() {
return (
<tr className={"table-dark"}>
<td>
<input
type="checkbox"
value={this.props.user.id}
className="form-check-input"
name="users"
/>
</td>
<td>
<a href="#">{this.props.user.name}</a>
</td>
<td>{this.props.user.user.email}</td>
<td>{this.props.user.zendesk_role}</td>
</tr>
);
}
}
class ModelUserTableRows extends React.Component {
render() {
return ReactDOM.createPortal(
this.props.users.map((user, key) => (
<ModelUserTableRow user={user} key={key} />
)),
document.getElementById("tbody")
);
}
}
class ZendeskUserTableRow extends React.Component {
render() {
return (
<tr className={"table-secondary text-secondary"}>
<td></td>
<td>
<a href="#" style={{ color: "grey", fontStyle: "italic" }}>
{this.props.user.name}
</a>
</td>
<td style={{ color: "grey", fontStyle: "italic" }}>
{this.props.user.email}
</td>
<td style={{ color: "grey", fontStyle: "italic" }}>
{this.props.user.zendesk_role}
</td>
</tr>
);
}
}
class ZendeskUserTableRows extends React.Component {
render() {
return ReactDOM.createPortal(
this.props.users.map((user, key) => (
<ZendeskUserTableRow user={user} key={key} />
)),
document.getElementById("tbody")
);
}
}
class TableBody extends React.Component {
constructor(props) {
super(props);
this.state = {
users: [],
engineers: 0,
light_agents: 0,
zendesk_users: [],
max_agents: 3,
};
}
change_elemnts_html() {
let elements = document.querySelectorAll(".info-quantity-value");
let licences = document.getElementById("licences_remaining");
elements[0].innerHTML = this.state.engineers;
elements[1].innerHTML = this.state.light_agents;
let max_licences = Math.max(
this.state.max_agents - this.state.engineers,
0
);
licences.innerHTML = "Свободных мест: " + max_licences;
}
async get_users() {
await axios.get("/api/users").then((response) => {
this.setState({
users: response.data.users,
engineers: response.data.engineers,
light_agents: response.data.light_agents,
zendesk_users: response.data.zendesk_users,
max_agents: response.data.max_agents,
});
});
this.change_elemnts_html();
}
delete_pretext() {
document.getElementById("loading").remove();
}
componentDidMount() {
this.get_users().then(() => this.delete_pretext());
this.interval = setInterval(() => {
this.get_users();
}, 60000);
}
componentWillUnmount() {
clearInterval(this.interval);
}
render() {
return (
<tr>
<ModelUserTableRows users={this.state.users} />
<ZendeskUserTableRows users={this.state.zendesk_users} />
</tr>
);
}
}
ReactDOM.render(<TableBody />, document.getElementById("tbody"));
head_checkbox();

0
static/main/js/control_page/.gitkeep Normal file
View File