Module jumpscale.tools.nginx.nginxserver

Classes

class NginxServer (*args, **kwargs)

A simple attribute-based namespace.

SimpleNamespace(**kwargs)

base class implementation for any class with fields which supports getting/setting raw data for any instance fields.

any instance can have an optional name and a parent.

class Person(Base):
    name = fields.String()
    age = fields.Float()

p = Person(name="ahmed", age="19")
print(p.name, p.age)

Args

parent_ : Base, optional

parent instance. Defaults to None.

instance_name_ : str, optional

instance name. Defaults to None.

**values

any given field values to initiate the instance with

Expand source code

class NginxServer(Base):
    server_name = fields.String(default="main")

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.config_path = j.sals.fs.join_paths(j.core.dirs.CFGDIR, "nginx", self.server_name, "nginx.conf")

    @property
    def check_command_string(self):
        return r"nginx.* \-c {CONFIG_PATH}".format(CONFIG_PATH=j.sals.fs.expanduser(self.config_path))

    @property
    def installed(self) -> bool:
        """check if nginx is installed

        Returns:
            bool: True if nginx is installed
        """
        return shutil.which("nginx")

    def start(self):
        """
        start nginx server using your config path
        """
        nginx = j.sals.nginx.get(self.server_name)
        nginx.configure()
        cmd = j.tools.startupcmd.get(f"nginx_{self.server_name}")
        cmd.start_cmd = f"nginx -c {self.config_path}"
        cmd.stop_cmd = f"nginx -c {self.config_path} -s stop"
        cmd.path = nginx.cfg_dir
        cmd.timeout = 10
        pid_file_path = self.get_pid_file_path()
        cmd.check_cmd = f'pid=$(cat "{pid_file_path}") && [[ $(ps -p $pid -o command=) == "nginx: master"* ]]'
        cmd.process_strings_regex = [self.check_command_string]
        cmd.save()
        if not cmd.is_running():
            cmd.start()

    def stop(self):
        """
        stop nginx server
        """
        cmd = j.tools.startupcmd.get(f"nginx_{self.server_name}")
        cmd.stop()

    def is_running(self):
        """Check if nginxserver is running

        Returns:
            bool: True if Nginx master process is running, otherwise False.
        """
        return j.tools.startupcmd.get(f"nginx_{self.server_name}").is_running()

    def reload(self):
        """
        reload nginx server using your config path
        """
        j.sals.process.execute(f"nginx -c {self.config_path} -s reload")

    def restart(self):
        """
        restart nginx server
        """
        self.stop()
        self.start()

    def get_pid_file_path(self):
        """Return the path to nginx.pid file as specified in the Nginx configuration file
        Raises:
            j.exceptions.Runtime: if pid directive not found in the Nginx configuration file
            FileNotFoundError: if the Nginx configuration file not found
        Returns:
            str: the path to the file that process ID of the Nginx master process is written to.
        """
        with open(j.sals.fs.expanduser(self.config_path), "r") as file:
            for line in file:
                m = re.match(r"^pid\s+(.*);", line)
                if m:
                    pid_file_path = m.group(1)
                    return pid_file_path
            else:
                raise j.exceptions.Runtime(
                    f"can't read the PID directive in the Nginx configuration file {self.config_path}"
                )

Ancestors

• Base
• types.SimpleNamespace

Instance variables

var check_command_string

Expand source code

@property
def check_command_string(self):
    return r"nginx.* \-c {CONFIG_PATH}".format(CONFIG_PATH=j.sals.fs.expanduser(self.config_path))

var installed : bool

check if nginx is installed

Returns

bool

True if nginx is installed

Expand source code

@property
def installed(self) -> bool:
    """check if nginx is installed

    Returns:
        bool: True if nginx is installed
    """
    return shutil.which("nginx")

var server_name

getter method this property

will call _get_value, which would if the value is already defined and will get the default value if not

Returns

any

the field value

Expand source code

def getter(self):
    """
    getter method this property

    will call `_get_value`, which would if the value is already defined
    and will get the default value if not

    Returns:
        any: the field value
    """
    return self._get_value(name, field)

Methods

def get_pid_file_path(self)

Return the path to nginx.pid file as specified in the Nginx configuration file

Raises

j.exceptions.Runtime

if pid directive not found in the Nginx configuration file

FileNotFoundError

if the Nginx configuration file not found

Returns

str

the path to the file that process ID of the Nginx master process is written to.

Expand source code

def get_pid_file_path(self):
    """Return the path to nginx.pid file as specified in the Nginx configuration file
    Raises:
        j.exceptions.Runtime: if pid directive not found in the Nginx configuration file
        FileNotFoundError: if the Nginx configuration file not found
    Returns:
        str: the path to the file that process ID of the Nginx master process is written to.
    """
    with open(j.sals.fs.expanduser(self.config_path), "r") as file:
        for line in file:
            m = re.match(r"^pid\s+(.*);", line)
            if m:
                pid_file_path = m.group(1)
                return pid_file_path
        else:
            raise j.exceptions.Runtime(
                f"can't read the PID directive in the Nginx configuration file {self.config_path}"
            )

def is_running(self)

Check if nginxserver is running

Returns

bool

True if Nginx master process is running, otherwise False.

Expand source code

def is_running(self):
    """Check if nginxserver is running

    Returns:
        bool: True if Nginx master process is running, otherwise False.
    """
    return j.tools.startupcmd.get(f"nginx_{self.server_name}").is_running()

def reload(self)

reload nginx server using your config path

Expand source code

def reload(self):
    """
    reload nginx server using your config path
    """
    j.sals.process.execute(f"nginx -c {self.config_path} -s reload")

def restart(self)

restart nginx server

Expand source code

def restart(self):
    """
    restart nginx server
    """
    self.stop()
    self.start()

def start(self)

start nginx server using your config path

Expand source code

def start(self):
    """
    start nginx server using your config path
    """
    nginx = j.sals.nginx.get(self.server_name)
    nginx.configure()
    cmd = j.tools.startupcmd.get(f"nginx_{self.server_name}")
    cmd.start_cmd = f"nginx -c {self.config_path}"
    cmd.stop_cmd = f"nginx -c {self.config_path} -s stop"
    cmd.path = nginx.cfg_dir
    cmd.timeout = 10
    pid_file_path = self.get_pid_file_path()
    cmd.check_cmd = f'pid=$(cat "{pid_file_path}") && [[ $(ps -p $pid -o command=) == "nginx: master"* ]]'
    cmd.process_strings_regex = [self.check_command_string]
    cmd.save()
    if not cmd.is_running():
        cmd.start()

def stop(self)

stop nginx server

Expand source code

def stop(self):
    """
    stop nginx server
    """
    cmd = j.tools.startupcmd.get(f"nginx_{self.server_name}")
    cmd.stop()

Inherited members

• Base:
  • from_dict
  • to_dict
  • validate