CM-22808 - Build CLI executable

.github/workflows/build_executable.yml

@@ -0,0 +1,48 @@
+name: Build executable version of CLI
+
+on:
+  push:
+    branches:
+      #      - main
+      - "CM-22808-Build-CLI-executable"
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      - name: Setup Poetry
+        uses: snok/install-poetry@v1
+
+      - name: Install dependencies
+        run: poetry install
+
+      - name: Build executable
+        run: poetry run pyinstaller pyinstaller.spec
+
+      - name: Test executable
+        if: ${{ !startsWith(matrix.os, 'windows') }}
+        run: ./dist/cycode --version
+
+      - name: Test executable on Windows
+        if: ${{ startsWith(matrix.os, 'windows') }}
+        run: Invoke-expression -command ".\dist\cycode.exe --version"
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: cycode-cli-${{ matrix.os }}
+          path: dist

cycode/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.0'   # placeholder. Will be filled automatically on poetry build from Git Tag
+__version__ = '0.0.0'   # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag

pyinstaller.spec

@@ -0,0 +1,67 @@
+# -*- mode: python ; coding: utf-8 -*-
+# Run `poetry run pyinstaller pyinstaller.spec` to generate the binary.
+
+
+block_cipher = None
+
+INIT_FILE_PATH = os.path.join('cycode', '__init__.py')
+
+# save the prev content of __init__ file
+with open(INIT_FILE_PATH, 'r', encoding='UTF-8') as file:
+    prev_content = file.read()
+
+new_content = """
+import dunamai as _dunamai
+__version__ = _dunamai.get_version('cycode', first_choice=_dunamai.Version.from_git).serialize(
+    metadata=False, bump=True, style=_dunamai.Style.Pep440
+)
+"""
+
+# write the code to get version from Git Tag in runtime
+# the code will be compiled once during creation of the bundle
+# the value of __version__ will be frozen
+with open(INIT_FILE_PATH, 'w', encoding='UTF-8') as file:
+    file.write(new_content)
+
+a = Analysis(
+    ['cycode/cli/main.py'],
+    pathex=[],
+    binaries=[],
+    datas=[('cycode/cli/config.yaml', 'cycode/cli'), ('cycode/cyclient/config.yaml', 'cycode/cyclient')],
+    hiddenimports=[],
+    hookspath=[],
+    hooksconfig={},
+    runtime_hooks=[],
+    excludes=['tests'],
+    win_no_prefer_redirects=False,
+    win_private_assemblies=False,
+    cipher=block_cipher,
+    noarchive=False,
+)
+pyz = PYZ(a.pure, a.zipped_data, cipher=block_cipher)
+
+exe = EXE(
+    pyz,
+    a.scripts,
+    a.binaries,
+    a.zipfiles,
+    a.datas,
+    [],
+    name='cycode',
+    debug=False,
+    bootloader_ignore_signals=False,
+    strip=False,
+    upx=True,
+    upx_exclude=[],
+    runtime_tmpdir=None,
+    console=True,
+    disable_windowed_traceback=False,
+    argv_emulation=False,
+    target_arch='universal2',
+    codesign_identity=None,
+    entitlements_file=None,
+)
+
+# rollback the prev content of the __init__ file
+with open(INIT_FILE_PATH, 'w', encoding='UTF-8') as file:
+    file.write(prev_content)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cycode"
-version = "0.0.0" # placeholder. Will be filled automatically on poetry build from Git Tag
+version = "0.0.0" # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag
 description = "Perform secrets/iac scans for your sources using Cycode's engine"
 keywords=["secret-scan", "cycode", "devops", "token", "secret", "security", "cycode", "code"]
 authors = ["Cycode <support@cycode.com>"]
@@ -26,12 +26,11 @@ classifiers = [
 cycode = "cycode.cli.main:main_cli"
 
 [tool.poetry.dependencies]
-python = "^3.7"
+python = ">=3.7,<3.12"
 click = ">=8.1.0,<8.2.0"
 colorama = ">=0.4.3,<0.5.0"
 pyyaml = ">=6.0,<7.0"
 marshmallow = ">=3.8.0,<3.9.0"
-typing = ">=3.7.4.3,<3.8.0.0"
 pathspec = ">=0.8.0,<0.9.0"
 gitpython = ">=3.1.30,<3.2.0"
 arrow = ">=0.17.0,<0.18.0"
@@ -47,8 +46,12 @@ pytest-mock = ">=3.10.0,<3.11.0"
 coverage = ">=7.2.3,<7.3.0"
 responses = ">=0.23.1,<0.24.0"
 
-# poetry self add "poetry-dynamic-versioning[plugin]"
+[tool.poetry.group.executable.dependencies]
+pyinstaller = ">=5.11.0,<5.12.0"
+dunamai = ">=1.16.1,<1.17.0"
+
 [tool.poetry-dynamic-versioning]
+# poetry self add "poetry-dynamic-versioning[plugin]"
 enable = true
 strict = true
 bump = true