travis2docker 7.0.0__py3-none-any.whl

travis2docker/travis2docker.py

@@ -0,0 +1,162 @@
+# pylint: disable=useless-object-inheritance,consider-using-with,print-used
+import pathlib
+import re
+import shutil
+import stat
+from tempfile import gettempdir
+
+import jinja2
+
+RE_ENV_STR = r"(?P<var>[\w]*)[ ]*[\=][ ]*[\"\']{0,1}" + r"(?P<value>[\w\.\-\_/\$\{\}\:,\(\)\#\* ]*)[\"\']{0,1}"
+RE_EXPORT_STR = r"^(?P<export>export|EXPORT)( )+" + RE_ENV_STR
+
+
+class Travis2Docker:
+    re_export = re.compile(RE_EXPORT_STR, re.MULTILINE)
+
+    @property
+    def dockerfile_template(self):
+        return self.jinja_env.get_template("Dockerfile_deployv")
+
+    @property
+    def new_image(self):
+        image_name = "%(repo_owner)s-%(repo_project)s" % self.os_kwargs
+        revision = self.os_kwargs["revision"]
+        for invalid_char in "@:/#.":
+            image_name = image_name.replace(invalid_char, "_")
+            revision = revision.replace(invalid_char, "_")
+        return ("%s:%s" % (image_name, revision)).lower()
+
+    @property
+    def build_template(self):
+        return self.jinja_env.get_template("10-build.sh")
+
+    @property
+    def run_template(self):
+        return self.jinja_env.get_template("20-run.sh")
+
+    @staticmethod
+    def chmod_execution(file_path):
+        file_path.chmod(file_path.stat().st_mode | stat.S_IEXEC)
+
+    def __init__(
+        self,
+        image=None,
+        work_path=None,
+        dockerfile=None,
+        templates_path=None,
+        os_kwargs=None,
+        copy_paths=None,
+        build_env_args=None,
+        build_extra_steps=None,
+    ):
+        self.curr_work_path = None
+        self.build_extra_params = {}
+        self.run_extra_params = {}
+        self.build_env_args = build_env_args
+        self.build_extra_steps = build_extra_steps
+        if os_kwargs is None:
+            os_kwargs = {}
+        if copy_paths is None:
+            copy_paths = []
+        self.variables_sh_data = {
+            var.lower(): value for _, _, var, value in self.re_export.findall(os_kwargs["variables_sh"])
+        }
+        self.variables_sh_data.update({"sha_short": os_kwargs["sha"][:7]})
+        if not image:
+            image = "%(docker_image_repo)s:%(main_app)s-%(version)s-%(sha_short)s" % self.variables_sh_data
+        module_dir = pathlib.Path(__file__).resolve().parent
+        templates_dir = module_dir / "templates"
+        copy_paths.append([templates_dir / "build.sh", "/home/odoo/build.sh"])
+        copy_paths.append([templates_dir / "entrypoint_deployv.sh", "/entrypoint.sh"])
+        copy_paths.append([module_dir / "docker_helper", "/home/odoo/build"])
+        copy_paths.append([templates_dir / ".vscode", "/home/odoo/.vscode"])
+        copy_paths.append([templates_dir / ".coveragerc", "/home/odoo/.coveragerc"])
+        os_kwargs.setdefault("user", "odoo")
+        if dockerfile is None:
+            dockerfile = "Dockerfile"
+        if templates_path is None:
+            templates_path = templates_dir
+        self.copy_paths = copy_paths
+        self.os_kwargs = os_kwargs
+        self.jinja_env = jinja2.Environment(loader=jinja2.FileSystemLoader(templates_path))
+        self.image = image
+        if work_path is None:
+            self.work_path = pathlib.Path(gettempdir()) / pathlib.Path(__file__).stem
+        else:
+            self.work_path = pathlib.Path(work_path).expanduser()
+        self.dockerfile = dockerfile
+
+    def compute_build_scripts(self):
+        build_path = self.curr_work_path / "10-build.sh"
+        run_path = self.curr_work_path / "20-run.sh"
+        with build_path.open("w") as f_build, run_path.open("w") as f_run:
+            build_content = self.build_template.render(
+                image=self.new_image, dirname_dockerfile=self.curr_work_path, **self.build_extra_params
+            ).strip("\n ")
+            f_build.write(build_content)
+            run_content = self.run_template.render(image=self.new_image, **self.run_extra_params).strip("\n ")
+            f_run.write(run_content)
+        self.chmod_execution(build_path)
+        self.chmod_execution(run_path)
+
+    def compute_dockerfile(self):
+        self.curr_work_path = self.work_path
+        curr_dockerfile = self.curr_work_path / self.dockerfile
+        self.curr_work_path.mkdir(exist_ok=True, parents=True)
+        copies = []
+        for copy_path, dest in self.copy_paths:
+            copies.append((self.copy_path(copy_path), dest))
+        self.set_authorized_key()
+        kwargs = {
+            "copies": copies,
+            "image": self.image,
+            "build_env_args": self.build_env_args,
+            "build_extra_steps": self.build_extra_steps,
+        }
+        kwargs.update(self.os_kwargs)
+        with curr_dockerfile.open("w") as f_dockerfile:
+            dockerfile_content = self.dockerfile_template.render(kwargs).strip("\n ")
+            f_dockerfile.write(dockerfile_content)
+        self.compute_build_scripts()
+        work_paths = [str(self.curr_work_path)]
+        self.curr_work_path = None
+        return work_paths
+
+    def copy_path(self, path):
+        """:param paths list: List of paths to copy"""
+        src = pathlib.Path(path).expanduser()
+        dest_path = self.curr_work_path / src.name
+        if dest_path.is_dir():
+            shutil.rmtree(dest_path)
+        if src.is_dir():
+            try:
+                shutil.copytree(src, dest_path)
+            except shutil.Error:  # pylint: disable=except-pass
+                pass  # There are permissions errors to copy
+        elif src.is_file():
+            shutil.copy(src, dest_path)
+        else:
+            raise UserWarning("Just directory or file is supported to copy [%s]" % src)
+        return str(dest_path.relative_to(self.curr_work_path))
+
+    def set_authorized_key(self):
+        ssh_dir = pathlib.Path("~/.ssh").expanduser()
+        ed_key = ssh_dir / "id_ed25519.pub"
+        rsa_key = ssh_dir / "id_rsa.pub"
+
+        to_copy = None
+        if ed_key.is_file():
+            to_copy = ed_key
+        elif rsa_key.is_file():
+            print("RSA keys are deprecated, consider changing to ed25519")
+            to_copy = rsa_key
+
+        if not to_copy:
+            print("No public key found. No key added to ~/.ssh/authorized_keys. SSH login won't work.")
+            return
+
+        pub_key = to_copy.read_text(encoding="utf-8")
+
+        with (self.curr_work_path / ".ssh" / "authorized_keys").open("a", encoding="utf-8") as auth_fd:
+            auth_fd.write(pub_key)

travis2docker-7.0.0.dist-info/METADATA

@@ -0,0 +1,268 @@
+Metadata-Version: 2.4
+Name: travis2docker
+Version: 7.0.0
+Summary: Script to generate a development Dockerfile from the deployv image of a repository
+Home-page: https://github.com/vauxoo/travis2docker
+Author: Vauxoo
+Author-email: info@vauxoo.com
+License: BSD-3-Clause
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: Unix
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: Jinja2==3.1.*
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+========
+Overview
+========
+
+
+
+Script to generate a development Dockerfile from the deployv image of a repository (based on its ``variables.sh`` file)
+
+* Free software: BSD license
+
+Installation
+============
+
+::
+
+    pip install travis2docker
+
+Usage
+=====
+
+`travisfile2dockerfile REPO_URL BRANCH`
+ 
+Or with pull request
+ `travisfile2dockerfile REPO_URL pull/##`
+ 
+In REPO_URL use the ssh url of github.
+
+For more information execute:
+ `travisfile2dockerfile --help`
+ 
+Example:
+ `travisfile2dockerfile --root-path=$HOME/t2d git@github.com:Vauxoo/forecast.git 8.0`
+
+The output is:
+ `${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0`
+
+To build image:
+ `${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/10-build.sh`
+
+To create container:
+ `${HOME}/t2d/script/git_github.com_Vauxoo_forecast.git/8.0/20-run.sh --entrypoint=bash`
+
+The repository needs a ``variables.sh`` file in its root path (the one used by
+the deployv images built from the CI). By default the docker image is built
+from its values as ``DOCKER_IMAGE_REPO:MAIN_APP-VERSION-SHA_SHORT``; use
+``--docker-image=quay.io/vauxoo/PROJECT:TAG`` to pick the image pushed by the
+``build_docker`` pipeline instead.
+
+Optional tools (``--build-env-args``)
+=====================================
+
+Some development tools are **not** installed by default. They are enabled with
+a flag passed as a build environment variable using ``--build-env-args``, which
+generates an ``ENV <FLAG>=TRUE`` line in the Dockerfile. If the flag is not
+defined, the installation step is skipped.
+
+.. list-table::
+    :widths: 30 70
+    :header-rows: 1
+
+    * - Flag
+      - Installs
+    * - ``VIM_INSTALL``
+      - vim + spf13-vim, vim-openerp, jedi-vim, wakatime and the pylint_odoo/eslint syntastic configuration
+    * - ``ZSH_INSTALL``
+      - zsh + oh-my-zsh with the ``odoo-shippable`` theme
+
+Example enabling more than one::
+
+    travisfile2dockerfile --build-env-args VIM_INSTALL ZSH_INSTALL \
+        git@github.com:Vauxoo/forecast.git 8.0
+
+codebase-memory-deployv
+=======================
+
+The image ships with `codebase-memory-deployv
+<https://pypi.org/project/codebase-memory-deployv>`__, a wrapper that deploys
+`codebase-memory-mcp <https://github.com/DeusData/codebase-memory-mcp>`__
+(code knowledge graph for AI agents) for instances following this layout.
+
+The repository is **not** indexed while building the image. Run inside the
+container::
+
+    codebase-memory-deployv
+
+It installs codebase-memory-mcp if it is missing, derives the project name from
+``${MAIN_REPO_FULL_PATH}/variables.sh`` (e.g. ``forecast_17.0``), and indexes
+``/home/odoo/instance`` in batches of modules. Indexing takes a few minutes on
+a big instance, so it is left as an explicit step for the user.
+
+Depends
+=======
+
+SSH key without password
+************************
+
+Dockerfile doesn't support a prompt to enter your password, so you need to remove it from your ssh keys.
+
+::
+
+  export fname=~/.ssh/id_rsa
+  cp ${fname} ${fname}_with_pwd
+  openssl rsa -in ${fname} -out ${fname}_without_pwd
+  cp ${fname}_without_pwd ${fname}
+
+Install docker
+**************
+
+https://docs.docker.com/engine/installation/
+
+Documentation
+=============
+
+https://travis2docker.readthedocs.io/
+
+Development
+===========
+
+To run the all tests run::
+
+    tox
+
+Note, to combine the coverage data from all the tox environments run:
+
+.. list-table::
+    :widths: 10 90
+    :stub-columns: 1
+
+    - - Windows
+      - ::
+
+            set PYTEST_ADDOPTS=--cov-append
+            tox
+
+    - - Other
+      - ::
+
+            PYTEST_ADDOPTS=--cov-append tox
+
+
+Release process
+===============
+
+This project uses `bump2version <https://github.com/c4urself/bump2version>`_ to
+manage version bumps across ``.bumpversion.cfg``, ``docs/conf.py``,
+``setup.py`` and ``src/travis2docker/__init__.py``.
+
+Requirements
+************
+
+* Write access to push to ``main`` and to push tags.
+* A GPG key configured for signing git tags. The CI pipeline that publishes
+  the package to PyPI only builds from **signed** tags::
+
+      git config --global user.signingkey <YOUR_GPG_KEY_ID>
+
+* ``bump2version`` installed::
+
+      pip install bump2version
+
+Steps to release a new version
+******************************
+
+
+1. Make sure you are on ``main`` and it is up to date, with no local commits
+   ahead of ``origin``::
+
+       git checkout main
+       git pull origin main
+       git status  # must be clean
+
+2. Bump the version. This creates a commit and a tag automatically
+   (choose ``patch``, ``minor`` or ``major`` as needed)::
+
+       bump2version patch
+
+   This updates::
+
+       .bumpversion.cfg
+       docs/conf.py
+       setup.py
+       src/travis2docker/__init__.py
+
+3. Verify the tag was created and that it is **signed**::
+
+       git tag -v vX.Y.Z
+
+   If ``sign_tags`` is not enabled in ``.bumpversion.cfg``, the tag created
+   in step 2 will **not** be signed and the CI build/publish step will not
+   run. In that case, re-create the tag manually before pushing::
+
+       git tag -d vX.Y.Z
+       git tag -s vX.Y.Z -m "vX.Y.Z"
+
+   To avoid this every time, add the following to ``.bumpversion.cfg``::
+
+       [bumpversion]
+       current_version = X.Y.Z
+       commit = True
+       tag = True
+       sign_tags = True
+
+4. Push the branch and the tag::
+
+       git push origin main --tags
+
+   Pushing the signed tag is what triggers the CI job that builds and
+   publishes the package to PyPI.
+
+Troubleshooting
+***************
+
+* **"tag already exists" / dirty working tree**: make sure ``git status`` is
+  clean and ``git pull origin main`` was run before ``bump2version``,
+  otherwise the bump commit/tag will be based on stale history.
+* **CI does not trigger a PyPI build**: check that the pushed tag is signed
+  (``git tag -v vX.Y.Z`` should show a valid GPG signature) and that
+  ``user.signingkey`` is configured correctly.
+
+
+Changelog
+=========
+
+3.0.0 (2016-07-26)
+******************
+
+* First release on PyPI.

travis2docker-7.0.0.dist-info/RECORD

@@ -0,0 +1,23 @@
+travis2docker/__init__.py,sha256=VgMOOqsYbyb60I1RmlZpqwqQ0C0IyT3R0c8_xX4pRGM,22
+travis2docker/__main__.py,sha256=WqseXLnYDF9u77kkfkWSNQmmqbloKs6jB_6SuYdqxDU,360
+travis2docker/cli.py,sha256=x4fPZnTZ_QmP83facpAzIbuoNJHchjdVxgxTHuv8ZcI,10294
+travis2docker/exceptions.py,sha256=03fh-vq7OIxnV-mdZlJOXaPmpuuaJ4bWAyjjICTPb4U,164
+travis2docker/git_run.py,sha256=hGAjZshe6hgs_IK5iweveojD-QZdxPLSWpfOvXX3W58,4053
+travis2docker/travis2docker.py,sha256=3yIQuYLuOjTQJCK2DX1m4fpnZWFHzBPXPUhLjMBJKt4,6357
+travis2docker/docker_helper/build.py,sha256=j3Ie0uohdqF4uSk0DA_7Tt78CeNPTvsZMKwIGJILmgQ,3181
+travis2docker/templates/.coveragerc,sha256=2r1H579-4RtUvI9yIUvNRTDcdn--OFaG4m4rx6S7PdA,1001
+travis2docker/templates/10-build.sh,sha256=1c6l2M5HncVD0Ci8l7Eo5W9Wf2D1lc7J57mg_JY5JLo,131
+travis2docker/templates/20-run.sh,sha256=qKqbuXQ5ZgyUwnAnIwtV5-VHa9SHY1VZ37GAeNwGSVg,688
+travis2docker/templates/Dockerfile_deployv,sha256=uIWcdjMgxMiX2JVfpWllnAzq82uEG6QDNaVmvKNbw2A,1541
+travis2docker/templates/build.sh,sha256=rsMa5pmNGrBbK3EZdS45eODMfxXfVADUId4zcv8ojpk,13546
+travis2docker/templates/entrypoint_deployv.sh,sha256=OFJSfWOuyAYutr6Tdq3usrXmG7-Fv6YYhCe4DzFcgw8,3750
+travis2docker/templates/.vscode/extensions.json,sha256=gfizS2OHGvKWXo-y0Q7oj4UyvFCGLdusglh8xLo_vuE,348
+travis2docker/templates/.vscode/launch.json,sha256=WkyQDKy_oS2CrqcaxivYbN9V00MSZGZUpva2cogNVLQ,842
+travis2docker/templates/.vscode/settings.json,sha256=ymRKw7lpudvSRk5oJFlb1jZsdCVuBmgSpmAF848bH5Y,436
+travis2docker-7.0.0.dist-info/licenses/AUTHORS.rst,sha256=5F1EtJ9_HPOlWYSO5YznKQdhPrdWpLAJkemyhRRtUis,53
+travis2docker-7.0.0.dist-info/licenses/LICENSE,sha256=bgW3tu3ZoMF92osxQEVZ62pRV61kN8YrRwmeSpKx_ks,1285
+travis2docker-7.0.0.dist-info/METADATA,sha256=0TxodLsIKEztqLodE4AqVLuGiVjye-j03W44MzBiGBc,7348
+travis2docker-7.0.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+travis2docker-7.0.0.dist-info/entry_points.txt,sha256=V-QtEHdMvHrLLRJOHHhvy0oMUI-yLYPxnTQ_f24Y6pA,65
+travis2docker-7.0.0.dist-info/top_level.txt,sha256=oCQJpJtAbfaMnh6ahkgn6d-RLqofWNZ_iNoEiIOUkpY,14
+travis2docker-7.0.0.dist-info/RECORD,,

travis2docker-7.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

travis2docker-7.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+travisfile2dockerfile = travis2docker.cli:main

travis2docker-7.0.0.dist-info/licenses/AUTHORS.rst

@@ -0,0 +1,5 @@
+
+Authors
+=======
+
+* Vauxoo - https://www.vauxoo.com/

travis2docker-7.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016, Vauxoo
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

travis2docker-7.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+travis2docker