# pylint:disable=line-too-long
"""
The tool to check the availability or syntax of domains, IPv4 or URL.
::
██████╗ ██╗ ██╗███████╗██╗ ██╗███╗ ██╗ ██████╗███████╗██████╗ ██╗ ███████╗
██╔══██╗╚██╗ ██╔╝██╔════╝██║ ██║████╗ ██║██╔════╝██╔════╝██╔══██╗██║ ██╔════╝
██████╔╝ ╚████╔╝ █████╗ ██║ ██║██╔██╗ ██║██║ █████╗ ██████╔╝██║ █████╗
██╔═══╝ ╚██╔╝ ██╔══╝ ██║ ██║██║╚██╗██║██║ ██╔══╝ ██╔══██╗██║ ██╔══╝
██║ ██║ ██║ ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝
This submodule will create the autosave logic.
Author:
Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom
Special thanks:
https://pyfunceble.github.io/special-thanks.html
Contributors:
https://pyfunceble.github.io/contributors.html
Project link:
https://github.com/funilrys/PyFunceble
Project documentation:
https://pyfunceble.readthedocs.io/en/master/
Project homepage:
https://pyfunceble.github.io/
License:
::
MIT License
Copyright (c) 2017, 2018, 2019 Nissar Chababy
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
# pylint: enable=line-too-long
from sys import stdout as sys_stdout
import PyFunceble
from PyFunceble.helpers import Command, Regex
from PyFunceble.percentage import Percentage
[docs]class AutoSave: # pragma: no cover pylint: disable=too-few-public-methods
"""
Provide the autosave logic.
:param bool is_last_domain:
Tell this subsystem if we are at the very end of the file testing.
:param bool is_bypass:
Tell this subsystem if we are in bypassing mode.
"""
# We set the varible which will save the global authorization to operate.
authorized = None
# We set the variable which will save the travis instance.
travis = None
# We set the variable which will save the starting time.
start_time = None
# We set the variable which will save the end time.
endtime = None
# We set the variable which will process as a chache for the
# time exceeed value.
time_exceed = False
def __init__(self, start_time=None):
self.travis = Travis()
self.travis.bypass()
self.authorized = self.authorization()
self.start_time = int(start_time)
self.end_time = self.start_time + (
int(PyFunceble.CONFIGURATION["travis_autosave_minutes"]) * 60
)
[docs] def authorization(self):
"""
Provide the authorization to operate.
"""
return self.travis.authorized
[docs] def is_time_exceed(self):
"""
Check if the end time is exceed.
"""
if self.authorized:
# We are authorized to operate.
if not self.time_exceed and int(PyFunceble.time()) >= self.end_time:
# * We did not tested previously if the time exceed.
# and
# * The time exceed.
# We update the time exceed marker.
self.time_exceed = True
return self.time_exceed
[docs] def process(self, test_completed=False):
"""
Process the autosave base on the current state of the test.
:param bool test_completed: Tell us if we finished the test.
"""
if self.authorized:
# We are authorized to operate with Travis.
if test_completed:
# The test was completed.
# We run the end commit.
self.travis.end_commit()
elif self.is_time_exceed():
# The current time excessed the minimal time for autosaving.
# We run the not end commit.
self.travis.not_end_commit()
[docs]class Travis:
"""
Provide the autosaving for under travis CI.
"""
# Save the authorization to process.
authorized = False
# We set the regex to match in order to bypass the execution of
# PyFunceble.
regex_bypass = r"\[PyFunceble\sskip\]"
def __init__(self):
self.authorized = self.authorization()
[docs] @classmethod
def authorization(cls):
"""
Provide the operation authorization.
"""
try:
_ = PyFunceble.environ["TRAVIS_BUILD_DIR"]
return PyFunceble.CONFIGURATION["travis"]
except KeyError:
return False
[docs] def permissions(self):
"""
Set permissions in order to avoid issues before commiting.
"""
if self.authorized:
build_dir = PyFunceble.environ["TRAVIS_BUILD_DIR"]
commands = [
"sudo chown -R travis:travis %s" % (build_dir),
"sudo chgrp -R travis %s" % (build_dir),
"sudo chmod -R g+rwX %s" % (build_dir),
"sudo chmod 777 -Rf %s.git"
% (build_dir + PyFunceble.directory_separator),
r"sudo find %s -type d -exec chmod g+x '{}' \;" % (build_dir),
]
for command in commands:
Command(command).execute()
if Command("git config core.sharedRepository").execute() == "":
Command("git config core.sharedRepository group").execute()
[docs] def bypass(self):
"""
Stop everything if :code:`[PyFunceble skip]` is matched into
the latest commit message.
"""
if (
self.authorized
and Regex(
Command("git log -1").execute(), self.regex_bypass, return_data=False
).match()
):
self.end_commit()
[docs] def push(self):
"""
Push.
"""
if self.authorized:
Command(
"git push origin {0}".format(PyFunceble.CONFIGURATION["travis_branch"])
).execute()
exit(0)
[docs] def end_commit(self):
"""
Commit and push at the very end of the test.
"""
if self.authorized:
Percentage().log()
self.permissions()
command = 'git add --all && git commit -a -m "{0}"'.format(
PyFunceble.CONFIGURATION["travis_autosave_final_commit"] + " [ci skip]"
)
if PyFunceble.CONFIGURATION["command_before_end"]:
for line in Command(
PyFunceble.CONFIGURATION["command_before_end"]
).run():
sys_stdout.write("{}\n".format(line))
self.permissions()
for line in Command(command).run():
sys_stdout.write("{}\n".format(line))
self.push()
[docs] def not_end_commit(self):
"""
Commit and push at on the middle of the test.
"""
if self.authorized:
Percentage().log()
self.permissions()
command = 'git add --all && git commit -a -m "{0}"'.format(
PyFunceble.CONFIGURATION["travis_autosave_commit"]
)
if PyFunceble.CONFIGURATION["command"]:
for line in Command(PyFunceble.CONFIGURATION["command"]).run():
sys_stdout.write("{}\n".format(line))
self.permissions()
for line in Command(command).run():
sys_stdout.write("{}\n".format(line))
self.push()