mirror of
https://github.com/dw-0/kiauh.git
synced 2026-08-03 12:57:53 +05:00
Compare commits
15
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e20b85e00c | ||
|
|
1d1bac1524 | ||
|
|
7b5522ac94 | ||
|
|
a42b730688 | ||
|
|
77d6c87aa0 | ||
|
|
b893ff14f7 | ||
|
|
43b0994ac5 | ||
|
|
040edc1d4f | ||
|
|
750dba1dbe | ||
|
|
6f4b471008 | ||
|
|
5077765fd6 | ||
|
|
9f97ae6c2a | ||
|
|
b90a8f13b1 | ||
|
|
ea1b794afd | ||
|
|
647a7d9400 |
@@ -122,9 +122,9 @@ changes!**
|
|||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
<h2 align="center">🌐 Sources & Further Information</h2>
|
<h2 align="center">⚙️ Core Components ⚙️</h2>
|
||||||
|
|
||||||
<table align="center">
|
<table align="center" style="text-align: center;">
|
||||||
<tr>
|
<tr>
|
||||||
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
||||||
@@ -140,67 +140,88 @@ changes!**
|
|||||||
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
|
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
|
||||||
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/KlipperScreen/KlipperScreen">KlipperScreen</a></h3></th>
|
<th><h3><a href="https://github.com/KlipperScreen/KlipperScreen">KlipperScreen</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
|
<th><img src="https://avatars.githubusercontent.com/KlipperScreen?v=4" alt="KlipperScreen Logo" height="64"></th>
|
||||||
<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
<th>by <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
||||||
<th>by <a href="https://github.com/alfrix">alfrix</a></th>
|
<th>by <a href="https://github.com/alfrix">alfrix</a></th>
|
||||||
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2 align="center">🧩 Community Extensions 🧩</h2>
|
||||||
|
|
||||||
|
<table align="center" style="text-align: center;">
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
<th><a href="https://github.com/OctoPrint/OctoPrint"><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></a></th>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
|
<th><a href="https://github.com/nlef/moonraker-telegram-bot"><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></a></th>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
|
<th><a href="https://github.com/Kragrathea/pgcode"><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></a></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th>by <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
||||||
<th>by <a href="https://github.com/nlef">nlef</a></th>
|
<th>by <a href="https://github.com/nlef">nlef</a></th>
|
||||||
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
<th>by <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
||||||
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
||||||
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><a href="https://github.com/TheSpaghettiDetective/moonraker-obico"><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></a></th>
|
||||||
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
||||||
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
||||||
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
||||||
<th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
<th>by <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
||||||
<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
<th>by <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
||||||
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
|
<th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
|
||||||
<th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
<th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
||||||
<th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
|
<th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
|
||||||
<th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
|
<th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="SimplyPrint Logo" height="64"></a></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
||||||
<th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
<th>by <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
||||||
<th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
<th>by <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/CodeMasterCody3D/DroidKlipp">DroidKlipp</a></h3></th>
|
||||||
|
<th><h3><a href="https://github.com/PEEKYPAUL/Moongate">Moongate</a></h3></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th><a href="https://github.com/CodeMasterCody3D/DroidKlipp"><img src="https://raw.githubusercontent.com/CodeMasterCody3D/DroidKlipp/main/logo.png" alt="DroidKlipp Logo" height="64"></a></th>
|
||||||
|
<th><a href="https://github.com/PEEKYPAUL/Moongate"><img src="https://raw.githubusercontent.com/PEEKYPAUL/Moongate/master/docs/moongate-icon.png" alt="Moongate Logo" height="64"></a></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>by <a href="https://github.com/CodeMasterCody3D">CodeMasterCody3D</a></th>
|
||||||
|
<th>by <a href="https://github.com/PEEKYPAUL">PEEKYPAUL</a></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
@@ -229,13 +250,3 @@ changes!**
|
|||||||
a [Ko-fi](https://ko-fi.com/dw__0) !
|
a [Ko-fi](https://ko-fi.com/dw__0) !
|
||||||
* Last but not least: Thank you to all contributors and members of the Klipper
|
* Last but not least: Thank you to all contributors and members of the Klipper
|
||||||
Community who like and share this project!
|
Community who like and share this project!
|
||||||
|
|
||||||
<hr>
|
|
||||||
|
|
||||||
<h4 align="center">A special thank you to JetBrains for sponsoring this project
|
|
||||||
with their incredible software!</h4>
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
|
|
||||||
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|||||||
+51
-33
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a>
|
<a>
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/kiauh.png" alt="KIAUH logo" height="181">
|
<img src="docs/assets/logo-large.png" alt="KIAUH logo" height="181">
|
||||||
<h1 align="center">Klipper Installation And Update Helper</h1>
|
<h1 align="center">Klipper Installation And Update Helper</h1>
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
@@ -34,13 +34,13 @@ KIAUH 是一个帮助您在 Linux 系统上安装 Klipper 的脚本工具,
|
|||||||
选择 `Choose OS -> Raspberry Pi OS (other)`:
|
选择 `Choose OS -> Raspberry Pi OS (other)`:
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager1.png" alt="KIAUH logo" height="350">
|
<img src="docs/assets/rpi_imager1.png" alt="KIAUH logo" height="350">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
|
* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img src="https://raw.githubusercontent.com/dw-0/kiauh/master/resources/screenshots/rpi_imager2.png" alt="KIAUH logo" height="350">
|
<img src="docs/assets/rpi_imager2.png" alt="KIAUH logo" height="350">
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
* 返回 Raspberry Pi Imager 主界面,选择对应的 SD 卡作为写入目标。
|
* 返回 Raspberry Pi Imager 主界面,选择对应的 SD 卡作为写入目标。
|
||||||
@@ -99,9 +99,9 @@ cd ~ && git clone https://github.com/dw-0/kiauh.git
|
|||||||
您会被要求输入 sudo 密码。
|
您会被要求输入 sudo 密码。
|
||||||
因为有几个功能需要 sudo 权限。
|
因为有几个功能需要 sudo 权限。
|
||||||
|
|
||||||
## 🌐 相关资源与更多信息
|
<h2 align="center">⚙️ 核心组件 ⚙️</h2>
|
||||||
|
|
||||||
<table align="center">
|
<table align="center" style="text-align: center;">
|
||||||
<tr>
|
<tr>
|
||||||
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
<th><h3><a href="https://github.com/Klipper3d/klipper">Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
<th><h3><a href="https://github.com/Arksine/moonraker">Moonraker</a></h3></th>
|
||||||
@@ -117,70 +117,93 @@ cd ~ && git clone https://github.com/dw-0/kiauh.git
|
|||||||
<th>由 <a href="https://github.com/Arksine">Arksine</a></th>
|
<th>由 <a href="https://github.com/Arksine">Arksine</a></th>
|
||||||
<th>由 <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
<th>由 <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
<th><h3><a href="https://github.com/fluidd-core/fluidd">Fluidd</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/jordanruthe/KlipperScreen">KlipperScreen</a></h3></th>
|
<th><h3><a href="https://github.com/KlipperScreen/KlipperScreen">KlipperScreen</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
<th><img src="https://raw.githubusercontent.com/fluidd-core/fluidd/master/docs/docs/assets/images/logo.svg" alt="Fluidd Logo" height="64"></th>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" height="64"></th>
|
<th><img src="https://avatars.githubusercontent.com/KlipperScreen?v=4" alt="KlipperScreen Logo" height="64"></th>
|
||||||
<th><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th>由 <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
<th>由 <a href="https://github.com/fluidd-core">fluidd-core</a></th>
|
||||||
<th>由 <a href="https://github.com/jordanruthe">jordanruthe</a></th>
|
<th>由 <a href="https://github.com/alfrix">alfrix</a></th>
|
||||||
<th>由 <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
<th></th>
|
||||||
</tr>
|
</tr>
|
||||||
|
</table>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2 align="center">🧩 社区扩展 🧩</h2>
|
||||||
|
|
||||||
|
<table align="center" style="text-align: center;">
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
<th><h3><a href="https://github.com/nlef/moonraker-telegram-bot">Moonraker-Telegram-Bot</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
<th><h3><a href="https://github.com/Kragrathea/pgcode">PrettyGCode for Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
<th><a href="https://github.com/OctoPrint/OctoPrint"><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></a></th>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></th>
|
<th><a href="https://github.com/nlef/moonraker-telegram-bot"><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></a></th>
|
||||||
<th><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></th>
|
<th><a href="https://github.com/Kragrathea/pgcode"><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></a></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th>由 <a href="https://github.com/OctoPrint">OctoPrint</a></th>
|
||||||
<th>由 <a href="https://github.com/nlef">nlef</a></th>
|
<th>由 <a href="https://github.com/nlef">nlef</a></th>
|
||||||
<th>由 <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
<th>由 <a href="https://github.com/Kragrathea">Kragrathea</a></th>
|
||||||
<th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/TheSpaghettiDetective/moonraker-obico">Obico for Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
<th><h3><a href="https://github.com/Clon1998/mobileraker_companion">Mobileraker's Companion</a></h3></th>
|
||||||
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
<th><h3><a href="https://octoeverywhere.com/?source=kiauh_readme">OctoEverywhere For Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><a href="https://github.com/TheSpaghettiDetective/moonraker-obico"><img src="https://avatars.githubusercontent.com/u/46323662?s=200&v=4" alt="Obico logo" height="64"></a></th>
|
||||||
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
<th><a href="https://github.com/Clon1998/mobileraker_companion"><img src="https://raw.githubusercontent.com/Clon1998/mobileraker/master/assets/icon/mr_appicon.png" alt="Mobileraker Logo" height="64"></a></th>
|
||||||
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
<th><a href="https://octoeverywhere.com/?source=kiauh_readme"><img src="https://octoeverywhere.com/img/logo.svg" alt="OctoEverywhere Logo" height="64"></a></th>
|
||||||
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
||||||
<th>由 <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
<th>由 <a href="https://github.com/Clon1998">Patrick Schmidt</a></th>
|
||||||
<th>由 <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
<th>由 <a href="https://github.com/QuinnDamerell">Quinn Damerell</a></th>
|
||||||
<th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/crysxd/OctoApp-Plugin">OctoApp For Klipper</a></h3></th>
|
||||||
<th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
|
<th><h3><a href="https://github.com/staubgeborener/klipper-backup">Klipper-Backup</a></h3></th>
|
||||||
<th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
<th><h3><a href="https://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th><a href="https://octoapp.eu/?source=kiauh_readme"><img src="https://octoapp.eu/octoapp.webp" alt="OctoApp Logo" height="64"></a></th>
|
||||||
<th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
|
<th><a href="https://github.com/staubgeborener/klipper-backup"><img src="https://avatars.githubusercontent.com/u/28908603?v=4" alt="Staubgeroner Avatar" height="64"></a></th>
|
||||||
<th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="" height="64"></a></th>
|
<th><a href="https://github.com/SimplyPrint"><img src="https://avatars.githubusercontent.com/u/64896552?s=200&v=4" alt="SimplyPrint Logo" height="64"></a></th>
|
||||||
</tr>
|
</tr>
|
||||||
<tr>
|
<tr>
|
||||||
|
<th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
||||||
<th>由 <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
<th>由 <a href="https://github.com/Staubgeborener">Staubgeborener</a></th>
|
||||||
<th>由 <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
<th>由 <a href="https://github.com/SimplyPrint">SimplyPrint</a></th>
|
||||||
</tr>
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th><h3><a href="https://github.com/CodeMasterCody3D/DroidKlipp">DroidKlipp</a></h3></th>
|
||||||
|
<th><h3><a href="https://github.com/PEEKYPAUL/Moongate">Moongate</a></h3></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th><a href="https://github.com/CodeMasterCody3D/DroidKlipp"><img src="https://raw.githubusercontent.com/CodeMasterCody3D/DroidKlipp/main/logo.png" alt="DroidKlipp Logo" height="64"></a></th>
|
||||||
|
<th><a href="https://github.com/PEEKYPAUL/Moongate"><img src="https://raw.githubusercontent.com/PEEKYPAUL/Moongate/master/docs/moongate-icon.png" alt="Moongate Logo" height="64"></a></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
|
<tr>
|
||||||
|
<th>由 <a href="https://github.com/CodeMasterCody3D">CodeMasterCody3D</a></th>
|
||||||
|
<th>由 <a href="https://github.com/PEEKYPAUL">PEEKYPAUL</a></th>
|
||||||
|
<th></th>
|
||||||
|
</tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
## 🎖️ 贡献者
|
<hr>
|
||||||
|
|
||||||
|
<h2 align="center">🎖️ 贡献者 🎖️</h2>
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<a href="https://github.com/dw-0/kiauh/graphs/contributors">
|
<a href="https://github.com/dw-0/kiauh/graphs/contributors">
|
||||||
@@ -192,15 +215,10 @@ cd ~ && git clone https://github.com/dw-0/kiauh.git
|
|||||||
<img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
|
<img src="https://repobeats.axiom.co/api/embed/a1afbda9190c04a90cf4bd3061e5573bc836cb05.svg" alt="Repobeats analytics image"/>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
## ✨ 特别感谢
|
<hr>
|
||||||
|
|
||||||
|
<h2 align="center">✨ 特别感谢 ✨</h2>
|
||||||
|
|
||||||
* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志!
|
* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志!
|
||||||
* 同时,非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人!
|
* 同时,非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人!
|
||||||
* 最后但同样重要的是:感谢所有为 Klipper 社区做出贡献的成员,以及喜欢和分享这个项目的朋友们!
|
* 最后但同样重要的是:感谢所有为 Klipper 社区做出贡献的成员,以及喜欢和分享这个项目的朋友们!
|
||||||
|
|
||||||
<h4 align="center">特别感谢 JetBrains 为本项目提供其出色的软件赞助!</h4>
|
|
||||||
<p align="center">
|
|
||||||
<a href="https://www.jetbrains.com/community/opensource/#support" target="_blank">
|
|
||||||
<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo (Main) logo." height="128">
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|||||||
@@ -0,0 +1,82 @@
|
|||||||
|
# Live System Testing
|
||||||
|
|
||||||
|
Live tests run KIAUH workflows against a real Debian 12 QEMU/KVM VM. They are
|
||||||
|
isolated from the local developer machine by design.
|
||||||
|
|
||||||
|
## Safety Rules
|
||||||
|
|
||||||
|
- Live tests NEVER run on the local machine.
|
||||||
|
- They require `KIAUH_LIVE_ALLOW=1`.
|
||||||
|
- The target host must be explicitly set via `KIAUH_LIVE_TARGET_HOST` and match
|
||||||
|
the VM in the inventory.
|
||||||
|
- Local hostnames, loopback addresses, and the current hostname are blocked.
|
||||||
|
|
||||||
|
## Prepare a VM
|
||||||
|
|
||||||
|
1. Create a Debian 12 QEMU/KVM VM.
|
||||||
|
2. Create a user with passwordless sudo.
|
||||||
|
3. Install an SSH key for that user.
|
||||||
|
4. Install KIAUH on the VM (e.g. clone this repository).
|
||||||
|
5. Create a clean snapshot named `clean`:
|
||||||
|
```bash
|
||||||
|
virsh snapshot-create-as debian12-kiauh clean
|
||||||
|
```
|
||||||
|
|
||||||
|
## Inventory
|
||||||
|
|
||||||
|
`kiauh/live/inventory.yaml` defines non-sensitive VM settings. The host and SSH
|
||||||
|
key path are read from environment variables or a `.env` file so they are not
|
||||||
|
committed.
|
||||||
|
|
||||||
|
Create `.env` in the project root:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
KIAUH_LIVE_DEBIAN12_KIAUH_HOST=192.168.122.10
|
||||||
|
KIAUH_LIVE_DEBIAN12_KIAUH_KEY_FILE=/home/you/.ssh/kiauh_vm
|
||||||
|
```
|
||||||
|
|
||||||
|
Variable naming: `KIAUH_LIVE_<VM_NAME>_HOST` and `KIAUH_LIVE_<VM_NAME>_KEY_FILE`,
|
||||||
|
with the VM name uppercased and hyphens replaced by underscores.
|
||||||
|
|
||||||
|
You can also point to a custom inventory file:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export KIAUH_LIVE_INVENTORY=/path/to/inventory.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
## Run Live Tests
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export KIAUH_LIVE_ALLOW=1
|
||||||
|
export KIAUH_LIVE_TARGET_HOST=192.168.122.10
|
||||||
|
pytest -m live
|
||||||
|
```
|
||||||
|
|
||||||
|
Each scenario reverts the VM to the clean snapshot first, so scenarios are
|
||||||
|
independent.
|
||||||
|
|
||||||
|
## Add a Scenario
|
||||||
|
|
||||||
|
Create a YAML file in `kiauh/live/scenarios/`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Install Klipper on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
expected:
|
||||||
|
- type: service
|
||||||
|
name: klipper.service
|
||||||
|
state: running
|
||||||
|
```
|
||||||
|
|
||||||
|
Supported assertion types: `service`, `file`, `package`, `port`, `command`.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
- `UnsafeTargetError`: check `KIAUH_LIVE_ALLOW` and `KIAUH_LIVE_TARGET_HOST`.
|
||||||
|
- `InventoryError`: check the inventory YAML path and format.
|
||||||
|
- `LiveRunnerError` during snapshot revert: ensure `virsh` works and the domain
|
||||||
|
and snapshot names match the inventory.
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
## ⚠️ Working on this PRD
|
||||||
|
|
||||||
|
Do NOT implement this PRD directly. It has been broken into sequential tasks.
|
||||||
|
Work through the tasks below in order.
|
||||||
|
|
||||||
|
## Task Index
|
||||||
|
|
||||||
|
| # | Task | Todo | Blocked by | Status |
|
||||||
|
|---|------|------|------------|--------|
|
||||||
|
| 1/5 | VM inventory, SSH fixture, and safety guards | TODO-006 | — | 🔄 open |
|
||||||
|
| 2/5 | Scenario loader and Klipper install scenario | TODO-007 | TODO-006 | ⏳ blocked |
|
||||||
|
| 3/5 | Remove Klipper and Moonraker scenarios | TODO-008 | TODO-007 | ⏳ blocked |
|
||||||
|
| 4/5 | Mainsail and Fluidd install scenarios | TODO-009 | TODO-008 | ⏳ blocked |
|
||||||
|
| 5/5 | Backup, restore, and update scenarios | TODO-010 | TODO-009 | ⏳ blocked |
|
||||||
|
|
||||||
|
Start with: **TODO-006** (PRD #2 - Task 1/5: VM inventory, SSH fixture, and safety guards)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
# PRD #2: Isolated live-system acceptance test strategy on Debian 12 VM
|
||||||
|
|
||||||
|
**Tags:** `prd`, `prd-2`
|
||||||
|
|
||||||
|
## Problem Statement
|
||||||
|
|
||||||
|
- Pytest unit tests cannot validate real package installs, systemd services, git clones, and OS-specific behavior.
|
||||||
|
- Running workflow tests on a local developer machine risks destroying the environment.
|
||||||
|
- Need reproducible, isolated acceptance tests with explicit expected outcomes.
|
||||||
|
|
||||||
|
## Solution
|
||||||
|
|
||||||
|
- Acceptance tests run only on a pre-built Debian 12 QEMU/KVM VM.
|
||||||
|
- Test harness connects via SSH; never executes on the local host.
|
||||||
|
- YAML scenarios define workflows and expected outcomes.
|
||||||
|
- VM snapshot reverted before every scenario.
|
||||||
|
- Multi-layer safety prevents local execution.
|
||||||
|
|
||||||
|
## User Stories
|
||||||
|
|
||||||
|
1. As a maintainer, I want install/remove Klipper workflow tested on a real VM, so I know the installer still works.
|
||||||
|
2. As a maintainer, I want install/remove Moonraker workflow tested, so API stack compatibility is verified.
|
||||||
|
3. As a maintainer, I want Mainsail/Fluidd install workflow tested, so web client setup works end-to-end.
|
||||||
|
4. As a maintainer, I want backup/restore workflow tested, so user data survives the cycle.
|
||||||
|
5. As a maintainer, I want tests parameterized by VM inventory, so future Ubuntu/Debian versions can be added without code changes.
|
||||||
|
6. As a maintainer, I want local execution blocked by multiple guards, so the developer machine is never modified.
|
||||||
|
7. As a CI operator, I want scenario results to show expected vs actual outcome, so failures are actionable.
|
||||||
|
|
||||||
|
## Implementation Decisions
|
||||||
|
|
||||||
|
- VM inventory config supplies host/IP, SSH user/key, OS family. No auto-provisioning; base images are prepared in advance.
|
||||||
|
- Test harness: pytest + SSH fixture + Testinfra assertions. Commands are routed through SSH; assertions use Testinfra modules for service/file/package/port state.
|
||||||
|
- Scenario schema YAML: `name`, `os`, `steps` (commands/options), `expected` (assertions for service running, file exists, package installed, port reachable, process present).
|
||||||
|
- Snapshot reset: revert VM overlay before every scenario. Scenarios must be independent.
|
||||||
|
- Safety guards: require `KIAUH_LIVE_TARGET_HOST`; abort if value is `localhost`, `127.*`, or matches current hostname; abort if target resolves to a local interface; verify SSH host key differs from local; optional explicit confirmation prompt.
|
||||||
|
- Workflow priority: (1) install/remove Klipper; (2) install/remove Moonraker; (3) install Mainsail/Fluidd; (4) backup/restore; (5) update flows.
|
||||||
|
- Test user on VM has passwordless sudo; VM has internet access; long installs use timeouts.
|
||||||
|
- Scenario runner exposes expected outcome per step; failure shows command, expected assertion, and actual result.
|
||||||
|
|
||||||
|
## Testing Decisions
|
||||||
|
|
||||||
|
- Acceptance tests verify observable system state, not internal functions.
|
||||||
|
- Each scenario defines exact pre-state (clean snapshot) and post-state assertions.
|
||||||
|
- Flaky network commands are retried with timeout; failures attach relevant VM logs.
|
||||||
|
- Live suite is marked with a `live` pytest marker and excluded from the default `pytest` run.
|
||||||
|
|
||||||
|
## Out of Scope
|
||||||
|
|
||||||
|
- Running live tests on the local machine or bare metal.
|
||||||
|
- Auto-provisioning or building VM images.
|
||||||
|
- Testing every extension in the first iteration; only core workflows.
|
||||||
|
|
||||||
|
## Further Notes
|
||||||
|
|
||||||
|
- Future OS matrix (Ubuntu 22.04/24.04) is enabled by adding inventory entries and matching base images; no harness changes needed.
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
# PRD #2 - Task 1/5: VM inventory, SSH fixture, and safety guards
|
||||||
|
|
||||||
|
**Tags:** `task`, `prd-2`
|
||||||
|
|
||||||
|
## Parent PRD
|
||||||
|
|
||||||
|
PRD #2: Isolated live-system acceptance test strategy on Debian 12 VM (`docs/prd/PRD-002-live-vm-test-strategy.md`)
|
||||||
|
|
||||||
|
## What to build
|
||||||
|
|
||||||
|
Create the VM inventory config schema (host/IP, SSH user/key, OS family). Implement the SSH connection fixture and the multi-layer safety guards that abort if the target could be the local machine. Write tests for the guards without executing any workflow.
|
||||||
|
|
||||||
|
## Acceptance criteria
|
||||||
|
|
||||||
|
- [ ] Inventory config schema documented and validated.
|
||||||
|
- [ ] SSH fixture connects only when target is explicitly allowed.
|
||||||
|
- [ ] Guards block `localhost`, `127.*`, current hostname, local interfaces, and unknown SSH host keys.
|
||||||
|
- [ ] Guard tests run on the local machine and prove the blocks work.
|
||||||
|
|
||||||
|
## Blocked by
|
||||||
|
|
||||||
|
None — can start immediately.
|
||||||
|
|
||||||
|
## Next task
|
||||||
|
|
||||||
|
- TODO-007 (PRD #2 - Task 2/5: Scenario loader and Klipper install scenario)
|
||||||
|
|
||||||
|
## User stories addressed
|
||||||
|
|
||||||
|
- User story 5
|
||||||
|
- User story 6
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# PRD #2 - Task 2/5: Scenario loader and Klipper install scenario
|
||||||
|
|
||||||
|
**Tags:** `task`, `prd-2`
|
||||||
|
|
||||||
|
## Parent PRD
|
||||||
|
|
||||||
|
PRD #2: Isolated live-system acceptance test strategy on Debian 12 VM (`docs/prd/PRD-002-live-vm-test-strategy.md`)
|
||||||
|
|
||||||
|
## What to build
|
||||||
|
|
||||||
|
Implement the YAML scenario loader and the `live` pytest marker. Write the first end-to-end scenario: install Klipper on the Debian 12 VM, define expected outcomes (service file, env file, folders), and run it with snapshot revert before the scenario.
|
||||||
|
|
||||||
|
## Acceptance criteria
|
||||||
|
|
||||||
|
- [ ] YAML scenario loader parses `name`, `os`, `steps`, and `expected` assertions.
|
||||||
|
- [ ] `pytest -m live` runs only live scenarios; default run skips them.
|
||||||
|
- [ ] Klipper install scenario runs on the VM and passes.
|
||||||
|
- [ ] Snapshot revert happens before the scenario.
|
||||||
|
- [ ] Expected outcomes include file, service, and folder assertions.
|
||||||
|
|
||||||
|
## Blocked by
|
||||||
|
|
||||||
|
- TODO-006 (PRD #2 - Task 1/5: VM inventory, SSH fixture, and safety guards)
|
||||||
|
|
||||||
|
## Next task
|
||||||
|
|
||||||
|
- TODO-008 (PRD #2 - Task 3/5: Remove Klipper and Moonraker scenarios)
|
||||||
|
|
||||||
|
## User stories addressed
|
||||||
|
|
||||||
|
- User story 1
|
||||||
|
- User story 7
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# PRD #2 - Task 3/5: Remove Klipper and Moonraker scenarios
|
||||||
|
|
||||||
|
**Tags:** `task`, `prd-2`
|
||||||
|
|
||||||
|
## Parent PRD
|
||||||
|
|
||||||
|
PRD #2: Isolated live-system acceptance test strategy on Debian 12 VM (`docs/prd/PRD-002-live-vm-test-strategy.md`)
|
||||||
|
|
||||||
|
## What to build
|
||||||
|
|
||||||
|
Add remove-Klipper and install/remove-Moonraker scenarios. Each scenario starts from a clean snapshot. Capture relevant VM logs when a scenario fails to make debugging actionable.
|
||||||
|
|
||||||
|
## Acceptance criteria
|
||||||
|
|
||||||
|
- [ ] Remove Klipper scenario runs and verifies service/files are gone.
|
||||||
|
- [ ] Install Moonraker scenario runs and verifies service/config/log files.
|
||||||
|
- [ ] Remove Moonraker scenario runs and verifies cleanup.
|
||||||
|
- [ ] Failure output includes tail of installer/service logs.
|
||||||
|
|
||||||
|
## Blocked by
|
||||||
|
|
||||||
|
- TODO-007 (PRD #2 - Task 2/5: Scenario loader and Klipper install scenario)
|
||||||
|
|
||||||
|
## Next task
|
||||||
|
|
||||||
|
- TODO-009 (PRD #2 - Task 4/5: Mainsail and Fluidd install scenarios)
|
||||||
|
|
||||||
|
## User stories addressed
|
||||||
|
|
||||||
|
- User story 2
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
# PRD #2 - Task 4/5: Mainsail and Fluidd install scenarios
|
||||||
|
|
||||||
|
**Tags:** `task`, `prd-2`
|
||||||
|
|
||||||
|
## Parent PRD
|
||||||
|
|
||||||
|
PRD #2: Isolated live-system acceptance test strategy on Debian 12 VM (`docs/prd/PRD-002-live-vm-test-strategy.md`)
|
||||||
|
|
||||||
|
## What to build
|
||||||
|
|
||||||
|
Add install scenarios for Mainsail and Fluidd web clients. Assert that the static files are deployed and the reverse-proxy/service config is in place. Harden the snapshot-revert fixture so it runs reliably before every scenario.
|
||||||
|
|
||||||
|
## Acceptance criteria
|
||||||
|
|
||||||
|
- [ ] Mainsail install scenario passes on the VM.
|
||||||
|
- [ ] Fluidd install scenario passes on the VM.
|
||||||
|
- [ ] Expected outcomes check webroot directory and reverse-proxy config.
|
||||||
|
- [ ] Snapshot revert fixture is robust (wait for SSH, error on revert failure).
|
||||||
|
|
||||||
|
## Blocked by
|
||||||
|
|
||||||
|
- TODO-008 (PRD #2 - Task 3/5: Remove Klipper and Moonraker scenarios)
|
||||||
|
|
||||||
|
## Next task
|
||||||
|
|
||||||
|
- TODO-010 (PRD #2 - Task 5/5: Backup, restore, and update scenarios)
|
||||||
|
|
||||||
|
## User stories addressed
|
||||||
|
|
||||||
|
- User story 3
|
||||||
@@ -0,0 +1,32 @@
|
|||||||
|
# PRD #2 - Task 5/5: Backup, restore, and update scenarios
|
||||||
|
|
||||||
|
**Tags:** `task`, `prd-2`
|
||||||
|
|
||||||
|
## Parent PRD
|
||||||
|
|
||||||
|
PRD #2: Isolated live-system acceptance test strategy on Debian 12 VM (`docs/prd/PRD-002-live-vm-test-strategy.md`)
|
||||||
|
|
||||||
|
## What to build
|
||||||
|
|
||||||
|
Add backup/restore and update scenarios. Document the live test runbook: how to prepare the VM, set inventory, run scenarios, and read results. Ensure the whole live suite can be executed in one command.
|
||||||
|
|
||||||
|
## Acceptance criteria
|
||||||
|
|
||||||
|
- [ ] Backup scenario creates an archive with expected content.
|
||||||
|
- [ ] Restore scenario returns config files to expected state.
|
||||||
|
- [ ] Update scenario changes a component version/config observable on the VM.
|
||||||
|
- [ ] Runbook `docs/live-testing.md` covers VM setup, inventory, execution, and troubleshooting.
|
||||||
|
- [ ] Full `pytest -m live` run completes end-to-end.
|
||||||
|
|
||||||
|
## Blocked by
|
||||||
|
|
||||||
|
- TODO-009 (PRD #2 - Task 4/5: Mainsail and Fluidd install scenarios)
|
||||||
|
|
||||||
|
## Next task
|
||||||
|
|
||||||
|
None — this is the last task.
|
||||||
|
|
||||||
|
## User stories addressed
|
||||||
|
|
||||||
|
- User story 4
|
||||||
|
- User story 7
|
||||||
@@ -19,10 +19,12 @@ CROWSNEST_SERVICE_NAME = "crowsnest.service"
|
|||||||
|
|
||||||
# directories
|
# directories
|
||||||
CROWSNEST_DIR = Path.home().joinpath("crowsnest")
|
CROWSNEST_DIR = Path.home().joinpath("crowsnest")
|
||||||
|
CROWSNEST_ENV_DIR = Path.home().joinpath("crowsnest-env")
|
||||||
|
|
||||||
# files
|
# files
|
||||||
CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
|
CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
|
||||||
CROWSNEST_INSTALL_SCRIPT = CROWSNEST_DIR.joinpath("tools/install.sh")
|
CROWSNEST_INSTALL_SCRIPT = CROWSNEST_DIR.joinpath("tools/install.sh")
|
||||||
|
CROWSNEST_DEPS_JSON_FILE = CROWSNEST_DIR.joinpath("system-dependencies.json")
|
||||||
CROWSNEST_BIN_FILE = Path("/usr/local/bin/crowsnest")
|
CROWSNEST_BIN_FILE = Path("/usr/local/bin/crowsnest")
|
||||||
CROWSNEST_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
|
CROWSNEST_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
|
||||||
CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)
|
CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)
|
||||||
|
|||||||
@@ -16,7 +16,9 @@ from typing import List
|
|||||||
|
|
||||||
from components.crowsnest import (
|
from components.crowsnest import (
|
||||||
CROWSNEST_BIN_FILE,
|
CROWSNEST_BIN_FILE,
|
||||||
|
CROWSNEST_DEPS_JSON_FILE,
|
||||||
CROWSNEST_DIR,
|
CROWSNEST_DIR,
|
||||||
|
CROWSNEST_ENV_DIR,
|
||||||
CROWSNEST_INSTALL_SCRIPT,
|
CROWSNEST_INSTALL_SCRIPT,
|
||||||
CROWSNEST_LOGROTATE_FILE,
|
CROWSNEST_LOGROTATE_FILE,
|
||||||
CROWSNEST_MULTI_CONFIG,
|
CROWSNEST_MULTI_CONFIG,
|
||||||
@@ -25,6 +27,8 @@ from components.crowsnest import (
|
|||||||
CROWSNEST_SERVICE_NAME,
|
CROWSNEST_SERVICE_NAME,
|
||||||
)
|
)
|
||||||
from components.klipper.klipper import Klipper
|
from components.klipper.klipper import Klipper
|
||||||
|
from components.moonraker.utils.sysdeps_parser import SysDepsParser
|
||||||
|
from components.moonraker.utils.utils import load_sysdeps_json
|
||||||
from core.logger import DialogType, Logger
|
from core.logger import DialogType, Logger
|
||||||
from core.services.backup_service import BackupService
|
from core.services.backup_service import BackupService
|
||||||
from core.settings.kiauh_settings import KiauhSettings
|
from core.settings.kiauh_settings import KiauhSettings
|
||||||
@@ -34,6 +38,7 @@ from utils.common import (
|
|||||||
get_install_status,
|
get_install_status,
|
||||||
)
|
)
|
||||||
from utils.git_utils import (
|
from utils.git_utils import (
|
||||||
|
get_current_branch,
|
||||||
git_clone_wrapper,
|
git_clone_wrapper,
|
||||||
git_pull_wrapper,
|
git_pull_wrapper,
|
||||||
)
|
)
|
||||||
@@ -135,8 +140,7 @@ def update_crowsnest() -> None:
|
|||||||
|
|
||||||
git_pull_wrapper(CROWSNEST_DIR)
|
git_pull_wrapper(CROWSNEST_DIR)
|
||||||
|
|
||||||
deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
|
install_crowsnest_packages()
|
||||||
check_install_dependencies({*deps})
|
|
||||||
|
|
||||||
cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
|
cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
|
||||||
|
|
||||||
@@ -147,12 +151,68 @@ def update_crowsnest() -> None:
|
|||||||
|
|
||||||
|
|
||||||
def get_crowsnest_status() -> ComponentStatus:
|
def get_crowsnest_status() -> ComponentStatus:
|
||||||
files = [
|
"""
|
||||||
|
Get the current install status of Crowsnest. Depending on the version the installed
|
||||||
|
files are different. If a version is not yet specified, it will search for a
|
||||||
|
non_existant file resulting in 'Incomplete' status.
|
||||||
|
:return: Installation status
|
||||||
|
"""
|
||||||
|
files_dict = {
|
||||||
|
4: [
|
||||||
CROWSNEST_BIN_FILE,
|
CROWSNEST_BIN_FILE,
|
||||||
CROWSNEST_LOGROTATE_FILE,
|
CROWSNEST_LOGROTATE_FILE,
|
||||||
CROWSNEST_SERVICE_FILE,
|
CROWSNEST_SERVICE_FILE,
|
||||||
]
|
],
|
||||||
return get_install_status(CROWSNEST_DIR, files=files)
|
5: [CROWSNEST_SERVICE_FILE],
|
||||||
|
}
|
||||||
|
version = get_crowsnest_version()
|
||||||
|
|
||||||
|
non_existant = CROWSNEST_DIR.joinpath("non_existant")
|
||||||
|
files = files_dict.get(version, [non_existant])
|
||||||
|
|
||||||
|
env_dir = None
|
||||||
|
if version >= 5:
|
||||||
|
env_dir = CROWSNEST_ENV_DIR
|
||||||
|
return get_install_status(CROWSNEST_DIR, files=files, env_dir=env_dir)
|
||||||
|
|
||||||
|
|
||||||
|
def get_crowsnest_version() -> int:
|
||||||
|
"""
|
||||||
|
Get the current major version. Starting with v5 the default branch will be named
|
||||||
|
after the major version.
|
||||||
|
:return: Current major version
|
||||||
|
"""
|
||||||
|
version = get_current_branch(CROWSNEST_DIR)
|
||||||
|
if version is None:
|
||||||
|
return 0
|
||||||
|
if version == "master":
|
||||||
|
return 4
|
||||||
|
return int(version.removeprefix("v"))
|
||||||
|
|
||||||
|
|
||||||
|
def install_crowsnest_packages() -> None:
|
||||||
|
Logger.print_status("Parsing Crowsnest system dependencies ...")
|
||||||
|
|
||||||
|
crowsnest_deps = []
|
||||||
|
crowsnest_version = get_crowsnest_version()
|
||||||
|
if crowsnest_version >= 5 and CROWSNEST_DEPS_JSON_FILE.exists():
|
||||||
|
Logger.print_info(
|
||||||
|
f"Parsing system dependencies from {CROWSNEST_DEPS_JSON_FILE.name} ..."
|
||||||
|
)
|
||||||
|
parser = SysDepsParser()
|
||||||
|
sysdeps = load_sysdeps_json(CROWSNEST_DEPS_JSON_FILE)
|
||||||
|
crowsnest_deps.extend(parser.parse_dependencies(sysdeps))
|
||||||
|
|
||||||
|
elif crowsnest_version <= 4 and CROWSNEST_INSTALL_SCRIPT.exists():
|
||||||
|
Logger.print_info(
|
||||||
|
f"Parsing system dependencies from {CROWSNEST_INSTALL_SCRIPT.name} ..."
|
||||||
|
)
|
||||||
|
crowsnest_deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
|
||||||
|
|
||||||
|
if not crowsnest_deps:
|
||||||
|
raise ValueError("Error parsing crowsnest dependencies!")
|
||||||
|
|
||||||
|
check_install_dependencies({*crowsnest_deps})
|
||||||
|
|
||||||
|
|
||||||
def remove_crowsnest() -> None:
|
def remove_crowsnest() -> None:
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2026 Cody Dixon #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
# repo
|
||||||
|
DROIDKLIPP_REPO = "https://github.com/CodeMasterCody3D/DroidKlipp"
|
||||||
|
DROIDKLIPP_APK_URL = "https://github.com/CodeMasterCody3D/DroidKlipp-Android-APK/releases/latest/download/DroidKlipp.apk"
|
||||||
|
|
||||||
|
# directories
|
||||||
|
DROIDKLIPP_DIR = Path.home().joinpath("DroidKlipp")
|
||||||
|
|
||||||
|
# files
|
||||||
|
DROIDKLIPP_INSTALL_SCRIPT = DROIDKLIPP_DIR.joinpath("install_droidklipp.sh")
|
||||||
|
DROIDKLIPP_UNINSTALL_SCRIPT = DROIDKLIPP_DIR.joinpath("uninstall_droidklipp.sh")
|
||||||
|
DROIDKLIPP_MONITOR_FILE = DROIDKLIPP_DIR.joinpath("droidklipp_monitor.py")
|
||||||
|
DROIDKLIPP_DEPLOYED_MONITOR = Path.home().joinpath("droidklipp_monitor.py")
|
||||||
|
|
||||||
|
# service
|
||||||
|
DROIDKLIPP_SERVICE_NAME = "adb_monitor"
|
||||||
|
|
||||||
|
# packages
|
||||||
|
DROIDKLIPP_REQUIRED_PACKAGES = {"adb", "tmux", "x11-utils"}
|
||||||
@@ -0,0 +1,155 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2026 Cody Dixon #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from subprocess import CalledProcessError, run
|
||||||
|
|
||||||
|
from components.klipperscreen import KLIPPERSCREEN_DIR, KLIPPERSCREEN_ENV_DIR
|
||||||
|
from core.logger import DialogType, Logger
|
||||||
|
from extensions.base_extension import BaseExtension
|
||||||
|
from extensions.droidklipp import (
|
||||||
|
DROIDKLIPP_APK_URL,
|
||||||
|
DROIDKLIPP_DEPLOYED_MONITOR,
|
||||||
|
DROIDKLIPP_DIR,
|
||||||
|
DROIDKLIPP_INSTALL_SCRIPT,
|
||||||
|
DROIDKLIPP_MONITOR_FILE,
|
||||||
|
DROIDKLIPP_REPO,
|
||||||
|
DROIDKLIPP_REQUIRED_PACKAGES,
|
||||||
|
DROIDKLIPP_SERVICE_NAME,
|
||||||
|
DROIDKLIPP_UNINSTALL_SCRIPT,
|
||||||
|
)
|
||||||
|
from utils.common import check_install_dependencies
|
||||||
|
from utils.fs_utils import check_file_exist, run_remove_routines
|
||||||
|
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||||
|
from utils.input_utils import get_confirm
|
||||||
|
from utils.sys_utils import cmd_sysctl_service
|
||||||
|
|
||||||
|
|
||||||
|
# noinspection PyMethodMayBeStatic
|
||||||
|
class DroidKlippExtension(BaseExtension):
|
||||||
|
def install_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Installing DroidKlipp ...")
|
||||||
|
|
||||||
|
if not self._klipperscreen_exists():
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.WARNING,
|
||||||
|
[
|
||||||
|
"No KIAUH v6 KlipperScreen installation found!",
|
||||||
|
"DroidKlipp expects KlipperScreen at:",
|
||||||
|
f"● {KLIPPERSCREEN_DIR.joinpath('screen.py')}",
|
||||||
|
f"● {KLIPPERSCREEN_ENV_DIR.joinpath('bin/python')}",
|
||||||
|
"Install KlipperScreen first, then run this installer again.",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.INFO,
|
||||||
|
[
|
||||||
|
"DroidKlipp requires the Android APK to be installed on your Android device:",
|
||||||
|
DROIDKLIPP_APK_URL,
|
||||||
|
"\n\n",
|
||||||
|
"The installer will configure ADB forwarding, udev rules, the DroidKlipp monitor, and WiFi fallback.",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
if not get_confirm(
|
||||||
|
"Continue DroidKlipp installation?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=True,
|
||||||
|
):
|
||||||
|
Logger.print_info("Exiting DroidKlipp installation ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
check_install_dependencies(DROIDKLIPP_REQUIRED_PACKAGES)
|
||||||
|
git_clone_wrapper(DROIDKLIPP_REPO, DROIDKLIPP_DIR)
|
||||||
|
run(["chmod", "+x", DROIDKLIPP_INSTALL_SCRIPT], check=True)
|
||||||
|
run([DROIDKLIPP_INSTALL_SCRIPT], check=True)
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.SUCCESS,
|
||||||
|
["DroidKlipp successfully installed!"],
|
||||||
|
center_content=True,
|
||||||
|
)
|
||||||
|
except CalledProcessError as e:
|
||||||
|
Logger.print_error(f"Error during DroidKlipp installation:\n{e}")
|
||||||
|
except Exception as e:
|
||||||
|
Logger.print_error(f"Error during DroidKlipp installation:\n{e}")
|
||||||
|
|
||||||
|
def update_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Updating DroidKlipp ...")
|
||||||
|
|
||||||
|
if not check_file_exist(DROIDKLIPP_DIR):
|
||||||
|
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
cmd_sysctl_service(DROIDKLIPP_SERVICE_NAME, "stop")
|
||||||
|
|
||||||
|
git_pull_wrapper(DROIDKLIPP_DIR)
|
||||||
|
|
||||||
|
if check_file_exist(DROIDKLIPP_MONITOR_FILE):
|
||||||
|
run(
|
||||||
|
[
|
||||||
|
"install",
|
||||||
|
"-m",
|
||||||
|
"755",
|
||||||
|
str(DROIDKLIPP_MONITOR_FILE),
|
||||||
|
str(DROIDKLIPP_DEPLOYED_MONITOR),
|
||||||
|
],
|
||||||
|
check=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
cmd_sysctl_service(DROIDKLIPP_SERVICE_NAME, "start")
|
||||||
|
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.SUCCESS,
|
||||||
|
["DroidKlipp successfully updated!"],
|
||||||
|
center_content=True,
|
||||||
|
)
|
||||||
|
except CalledProcessError as e:
|
||||||
|
Logger.print_error(f"Error during DroidKlipp update:\n{e}")
|
||||||
|
cmd_sysctl_service(DROIDKLIPP_SERVICE_NAME, "start")
|
||||||
|
except Exception as e:
|
||||||
|
Logger.print_error(f"Error during DroidKlipp update:\n{e}")
|
||||||
|
cmd_sysctl_service(DROIDKLIPP_SERVICE_NAME, "start")
|
||||||
|
|
||||||
|
def remove_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Removing DroidKlipp ...")
|
||||||
|
|
||||||
|
if not check_file_exist(DROIDKLIPP_DIR):
|
||||||
|
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
if not get_confirm(
|
||||||
|
"Do you really want to uninstall DroidKlipp?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=True,
|
||||||
|
):
|
||||||
|
Logger.print_info("Exiting DroidKlipp uninstallation ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
if check_file_exist(DROIDKLIPP_UNINSTALL_SCRIPT):
|
||||||
|
run(["chmod", "+x", DROIDKLIPP_UNINSTALL_SCRIPT], check=True)
|
||||||
|
run([DROIDKLIPP_UNINSTALL_SCRIPT], check=True)
|
||||||
|
run_remove_routines(DROIDKLIPP_DIR)
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.SUCCESS,
|
||||||
|
["DroidKlipp successfully removed!"],
|
||||||
|
center_content=True,
|
||||||
|
)
|
||||||
|
except CalledProcessError as e:
|
||||||
|
Logger.print_error(f"Error during DroidKlipp removal:\n{e}")
|
||||||
|
except Exception as e:
|
||||||
|
Logger.print_error(f"Error during DroidKlipp removal:\n{e}")
|
||||||
|
|
||||||
|
def _klipperscreen_exists(self) -> bool:
|
||||||
|
return bool(
|
||||||
|
check_file_exist(KLIPPERSCREEN_DIR.joinpath("screen.py"))
|
||||||
|
and check_file_exist(KLIPPERSCREEN_ENV_DIR.joinpath("bin/python"))
|
||||||
|
)
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"metadata": {
|
||||||
|
"index": 15,
|
||||||
|
"module": "droidklipp_extension",
|
||||||
|
"maintained_by": "CodeMasterCody3D",
|
||||||
|
"display_name": "DroidKlipp",
|
||||||
|
"description": [
|
||||||
|
"Use an Android device as a KlipperScreen display via ADB and DroidKlipp APK / XServer XSDL integration",
|
||||||
|
"- Automatic USB ADB forwarding",
|
||||||
|
"- Optional WiFi fallback",
|
||||||
|
"- Starts and monitors KlipperScreen on the Android X server"
|
||||||
|
],
|
||||||
|
"website": "https://github.com/CodeMasterCody3D/DroidKlipp-Android-APK/releases",
|
||||||
|
"repo": "https://github.com/CodeMasterCody3D/DroidKlipp",
|
||||||
|
"updates": true
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# Copyright (C) 2026 Théo Gaillard <theo.gayar@gmail.com> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
# repo
|
||||||
|
KAMP_REPO = "https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging"
|
||||||
|
|
||||||
|
# directories
|
||||||
|
MODULE_PATH = Path(__file__).resolve().parent
|
||||||
|
KAMP_DIR = Path.home().joinpath("Klipper-Adaptive-Meshing-Purging")
|
||||||
|
KLIPPER_DIR = Path.home().joinpath("klipper")
|
||||||
|
|
||||||
|
# names
|
||||||
|
KAMP_MOONRAKER_UPDATER_NAME = "update_manager Klipper-Adaptive-Meshing-Purging"
|
||||||
+357
@@ -0,0 +1,357 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# Copyright (C) 2026 Théo Gaillard <theo.gayar@gmail.com> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# It integrates Klipper Adaptive Meshing & Purging (KAMP): #
|
||||||
|
# https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
|
||||||
|
import shutil
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
from components.klipper.klipper import Klipper
|
||||||
|
from components.moonraker.moonraker import Moonraker
|
||||||
|
from core.instance_manager.instance_manager import InstanceManager
|
||||||
|
from core.logger import DialogType, Logger
|
||||||
|
from core.services.backup_service import BackupService
|
||||||
|
from core.simple_config_parser.simple_config_parser import (
|
||||||
|
SimpleConfigParser,
|
||||||
|
)
|
||||||
|
from extensions.base_extension import BaseExtension
|
||||||
|
from extensions.klipper_adaptive_meshing_purging import (
|
||||||
|
KAMP_DIR,
|
||||||
|
KAMP_MOONRAKER_UPDATER_NAME,
|
||||||
|
KAMP_REPO,
|
||||||
|
KLIPPER_DIR,
|
||||||
|
)
|
||||||
|
from utils.config_utils import add_config_section, remove_config_section
|
||||||
|
from utils.fs_utils import check_file_exist, create_symlink, run_remove_routines
|
||||||
|
from utils.git_utils import git_clone_wrapper, git_pull_wrapper
|
||||||
|
from utils.input_utils import get_confirm
|
||||||
|
from utils.instance_utils import get_instances, stop_klipper_instances_interactively
|
||||||
|
|
||||||
|
|
||||||
|
# noinspection PyMethodMayBeStatic
|
||||||
|
class KlipperAdaptiveMeshingPurgingExtension(BaseExtension):
|
||||||
|
def install_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Installing Klipper Adaptive Meshing Purging...")
|
||||||
|
|
||||||
|
klipper_dir_exists = check_file_exist(KLIPPER_DIR)
|
||||||
|
if not klipper_dir_exists:
|
||||||
|
Logger.print_warn(
|
||||||
|
"No Klipper directory found! Unable to install extension."
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||||
|
|
||||||
|
kamp_exists = check_file_exist(KAMP_DIR) and self._check_cfg_exists(
|
||||||
|
kl_instances
|
||||||
|
)
|
||||||
|
|
||||||
|
overwrite = True
|
||||||
|
if kamp_exists:
|
||||||
|
overwrite = get_confirm(
|
||||||
|
question="Extension seems to be installed already. Overwrite?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not overwrite:
|
||||||
|
Logger.print_warn("Installation aborted due to user request.")
|
||||||
|
return
|
||||||
|
|
||||||
|
add_moonraker_update_section = get_confirm(
|
||||||
|
question="Add Klipper Adaptive Meshing and Purging to Moonraker update manager(s)?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
if not stop_klipper_instances_interactively(
|
||||||
|
kl_instances, "installation of KAMP"
|
||||||
|
):
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
git_clone_wrapper(KAMP_REPO, KAMP_DIR, force=True)
|
||||||
|
|
||||||
|
self._install_cfg(kl_instances)
|
||||||
|
|
||||||
|
if add_moonraker_update_section:
|
||||||
|
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||||
|
self._add_moonraker_update_manager_section(mr_instances)
|
||||||
|
else:
|
||||||
|
Logger.print_info(
|
||||||
|
"Skipping update section creation as per user request."
|
||||||
|
)
|
||||||
|
Logger.print_warn(
|
||||||
|
"Make sure to create the corresponding section in your moonraker.conf in order to have it appear in your frontend update manager!"
|
||||||
|
)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
Logger.print_error(
|
||||||
|
f"Error during Klipper Adaptive Meshing and Purging installation:\n{e}"
|
||||||
|
)
|
||||||
|
|
||||||
|
if kl_instances:
|
||||||
|
InstanceManager.start_all(kl_instances)
|
||||||
|
return
|
||||||
|
|
||||||
|
if kl_instances:
|
||||||
|
InstanceManager.start_all(kl_instances)
|
||||||
|
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.ATTENTION,
|
||||||
|
[
|
||||||
|
"Basic configuration files were created per instance. You must edit them to enable the extension.",
|
||||||
|
"Documentation:",
|
||||||
|
f"{KAMP_REPO}",
|
||||||
|
"\n\n",
|
||||||
|
"IMPORTANT:",
|
||||||
|
"1. If you'd like to use adaptive meshing, Klipper already has built-in support. Just call BED_MESH_CALIBRATE ADAPTIVE=1 in your PRINT_START macro. DO NOT USE THE FEATURE FROM THE EXTENSION",
|
||||||
|
"2. You MUST be thoughtful when editing values for the purge settings, as there is a risk to break parts of your printer.",
|
||||||
|
"3. According to KAMP's documentation, you should define 'max_extrude_cross_section' in 'printer.cfg' according to your needs.",
|
||||||
|
],
|
||||||
|
margin_bottom=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
Logger.print_ok("Klipper Adaptive Meshing and Purging installed successfully!")
|
||||||
|
|
||||||
|
def update_extension(self, **kwargs) -> None:
|
||||||
|
extension_installed = check_file_exist(KAMP_DIR)
|
||||||
|
if not extension_installed:
|
||||||
|
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
backup_before_update = get_confirm(
|
||||||
|
question="Backup Klipper Adaptive Meshing and Purging directory before update?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||||
|
|
||||||
|
if not stop_klipper_instances_interactively(kl_instances, "update of KAMP"):
|
||||||
|
return
|
||||||
|
|
||||||
|
Logger.print_status("Updating Klipper Adaptive Meshing and Purging...")
|
||||||
|
try:
|
||||||
|
if backup_before_update:
|
||||||
|
Logger.print_status(
|
||||||
|
"Backing up Klipper Adaptive Meshing and Purging directory ..."
|
||||||
|
)
|
||||||
|
svc = BackupService()
|
||||||
|
svc.backup_directory(
|
||||||
|
source_path=KAMP_DIR,
|
||||||
|
backup_name="Klipper-Adaptive-Meshing-Purging",
|
||||||
|
)
|
||||||
|
Logger.print_ok("Backup completed successfully.")
|
||||||
|
|
||||||
|
git_pull_wrapper(KAMP_DIR)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
Logger.print_error(
|
||||||
|
f"Error during Klipper Adaptive Meshing and Purging update:\n{e}"
|
||||||
|
)
|
||||||
|
|
||||||
|
if kl_instances:
|
||||||
|
InstanceManager.start_all(kl_instances)
|
||||||
|
return
|
||||||
|
|
||||||
|
if kl_instances:
|
||||||
|
InstanceManager.start_all(kl_instances)
|
||||||
|
|
||||||
|
Logger.print_ok(
|
||||||
|
"Klipper Adaptive Meshing and Purging updated successfully.", end="\n\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
def remove_extension(self, **kwargs) -> None:
|
||||||
|
extension_installed = check_file_exist(KAMP_DIR)
|
||||||
|
if not extension_installed:
|
||||||
|
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||||
|
|
||||||
|
if not stop_klipper_instances_interactively(kl_instances, "removal of KAMP"):
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
run_remove_routines(KAMP_DIR)
|
||||||
|
self._remove_cfg(kl_instances)
|
||||||
|
|
||||||
|
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||||
|
self._remove_moonraker_update_manager_section(mr_instances)
|
||||||
|
|
||||||
|
BackupService().backup_printer_cfg()
|
||||||
|
remove_config_section("include KAMP_Settings.cfg", kl_instances)
|
||||||
|
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.ATTENTION,
|
||||||
|
[
|
||||||
|
"You might want to remove [exclude_object] sections from 'printer.cfg', unless you use them for some other reason.",
|
||||||
|
"\n\n",
|
||||||
|
"You might also want to remove the [file_manager] sections from 'moonraker.conf', unless used otherwise.",
|
||||||
|
"\n\n",
|
||||||
|
"NOTE:",
|
||||||
|
"'KAMP_Settings.cfg' is NOT removed automatically. ",
|
||||||
|
"Please delete it manually if no longer needed.",
|
||||||
|
],
|
||||||
|
margin_bottom=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
except Exception as e:
|
||||||
|
Logger.print_error(f"Unable to remove extension:\n{e}")
|
||||||
|
|
||||||
|
if kl_instances:
|
||||||
|
InstanceManager.start_all(kl_instances)
|
||||||
|
return
|
||||||
|
|
||||||
|
if kl_instances:
|
||||||
|
InstanceManager.start_all(kl_instances)
|
||||||
|
|
||||||
|
Logger.print_ok("Klipper Adaptive Meshing and Purging removed successfully.")
|
||||||
|
|
||||||
|
def _install_cfg(self, kl_instances: List[Klipper]):
|
||||||
|
is_multi_instance = len(kl_instances) > 1
|
||||||
|
for instance in kl_instances:
|
||||||
|
cfg_dir = instance.base.cfg_dir
|
||||||
|
Logger.print_status(
|
||||||
|
f"Creating symlink for KAMP directory in '{cfg_dir}' ..."
|
||||||
|
)
|
||||||
|
create_symlink(KAMP_DIR.joinpath("Configuration"), cfg_dir.joinpath("KAMP"))
|
||||||
|
if is_multi_instance:
|
||||||
|
Logger.print_ok(f"Symlink successfully created for instance '{instance.suffix}'.")
|
||||||
|
else:
|
||||||
|
Logger.print_ok("Symlink successfully created.")
|
||||||
|
|
||||||
|
# We do not overwrite the existing config files ever
|
||||||
|
Logger.print_status(f"Creating KAMP_Settings.cfg in '{cfg_dir}' ...")
|
||||||
|
if check_file_exist(cfg_dir.joinpath("KAMP_Settings.cfg")):
|
||||||
|
Logger.print_info("File already exists! Skipping ...")
|
||||||
|
continue
|
||||||
|
try:
|
||||||
|
shutil.copy(
|
||||||
|
KAMP_DIR.joinpath("Configuration/KAMP_Settings.cfg"),
|
||||||
|
cfg_dir.joinpath("KAMP_Settings.cfg"),
|
||||||
|
)
|
||||||
|
if is_multi_instance:
|
||||||
|
Logger.print_ok(f"Config file successfully created for instance '{instance.suffix}'.")
|
||||||
|
else:
|
||||||
|
Logger.print_ok(f"Config file successfully created.")
|
||||||
|
except OSError as e:
|
||||||
|
Logger.print_error(f"Unable to create example config: {e}")
|
||||||
|
|
||||||
|
BackupService().backup_printer_cfg()
|
||||||
|
|
||||||
|
sections = ["include KAMP_Settings.cfg", "exclude_object"]
|
||||||
|
for instance in kl_instances:
|
||||||
|
cfg_file = instance.cfg_file
|
||||||
|
scp = SimpleConfigParser()
|
||||||
|
scp.read_file(cfg_file)
|
||||||
|
|
||||||
|
for section in sections:
|
||||||
|
if scp.has_section(section):
|
||||||
|
continue
|
||||||
|
Logger.print_status(f"Add '{section}' to '{cfg_file}' ...")
|
||||||
|
scp.add_section(section)
|
||||||
|
scp.write_file(cfg_file)
|
||||||
|
Logger.print_ok("Done!")
|
||||||
|
|
||||||
|
def _add_moonraker_update_manager_section(
|
||||||
|
self, mr_instances: List[Moonraker]
|
||||||
|
) -> None:
|
||||||
|
if not mr_instances:
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.WARNING,
|
||||||
|
[
|
||||||
|
"Moonraker not found! Klipper Adaptive Meshing and Purging update "
|
||||||
|
"manager support for Moonraker will not be added to moonraker.conf.",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
if not get_confirm(
|
||||||
|
"Continue Klipper Adaptive Meshing and Purging installation?",
|
||||||
|
default_choice=False,
|
||||||
|
allow_go_back=True,
|
||||||
|
):
|
||||||
|
Logger.print_info("Installation aborted due to user request.")
|
||||||
|
return
|
||||||
|
|
||||||
|
BackupService().backup_moonraker_conf()
|
||||||
|
|
||||||
|
add_config_section(
|
||||||
|
section=KAMP_MOONRAKER_UPDATER_NAME,
|
||||||
|
instances=mr_instances,
|
||||||
|
options=[
|
||||||
|
("type", "git_repo"),
|
||||||
|
("channel", "dev"),
|
||||||
|
("path", KAMP_DIR.as_posix()),
|
||||||
|
("origin", KAMP_REPO),
|
||||||
|
("managed_services", "klipper"),
|
||||||
|
("primary_branch", "main"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
add_config_section(
|
||||||
|
section="file_manager",
|
||||||
|
instances=mr_instances,
|
||||||
|
options=[
|
||||||
|
("enable_object_processing", "True"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
InstanceManager.restart_all(mr_instances)
|
||||||
|
|
||||||
|
Logger.print_ok(
|
||||||
|
"Klipper Adaptive Meshing and Purging successfully added to Moonraker update manager(s)!"
|
||||||
|
)
|
||||||
|
|
||||||
|
def _remove_moonraker_update_manager_section(
|
||||||
|
self, mr_instances: List[Moonraker]
|
||||||
|
) -> None:
|
||||||
|
if not mr_instances:
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.WARNING,
|
||||||
|
[
|
||||||
|
"Moonraker not found! Klipper Adaptive Meshing and Purging update "
|
||||||
|
"manager support for Moonraker will not be removed from moonraker.conf.",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
BackupService().backup_moonraker_conf()
|
||||||
|
|
||||||
|
remove_config_section(KAMP_MOONRAKER_UPDATER_NAME, mr_instances)
|
||||||
|
InstanceManager.restart_all(mr_instances)
|
||||||
|
|
||||||
|
Logger.print_ok(
|
||||||
|
"Klipper Adaptive Meshing and Purging successfully removed from Moonraker update manager(s)!"
|
||||||
|
)
|
||||||
|
|
||||||
|
def _check_cfg_exists(self, kl_instances: List[Klipper]) -> bool:
|
||||||
|
cfg_dirs = [instance.base.cfg_dir for instance in kl_instances]
|
||||||
|
|
||||||
|
for cfg_dir in cfg_dirs:
|
||||||
|
if (
|
||||||
|
check_file_exist(cfg_dir.joinpath("KAMP_Settings.cfg"))
|
||||||
|
and check_file_exist(cfg_dir.joinpath("KAMP/KAMP_Settings.cfg"))
|
||||||
|
and check_file_exist(cfg_dir.joinpath("KAMP/Adaptive_Meshing.cfg"))
|
||||||
|
and check_file_exist(cfg_dir.joinpath("KAMP/Line_Purge.cfg"))
|
||||||
|
and check_file_exist(cfg_dir.joinpath("KAMP/Smart_Park.cfg"))
|
||||||
|
and check_file_exist(cfg_dir.joinpath("KAMP/Voron_Purge.cfg"))
|
||||||
|
):
|
||||||
|
return True
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
def _remove_cfg(self, kl_instances: List[Klipper]) -> None:
|
||||||
|
cfg_dirs = [instance.base.cfg_dir for instance in kl_instances]
|
||||||
|
|
||||||
|
for cfg_dir in cfg_dirs:
|
||||||
|
Logger.print_status(f"Removing KAMP symlink in '{cfg_dir}' ...")
|
||||||
|
run_remove_routines(cfg_dir.joinpath("KAMP"))
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
{
|
||||||
|
"metadata": {
|
||||||
|
"index": 14,
|
||||||
|
"module": "klipper_adaptive_meshing_purging_extension",
|
||||||
|
"maintained_by": "theogayar",
|
||||||
|
"display_name": "Klipper Adaptive Meshing Purging",
|
||||||
|
"description": [
|
||||||
|
"Klipper extension for adaptive meshing and purging."
|
||||||
|
],
|
||||||
|
"repo": "https://github.com/kyleisah/Klipper-Adaptive-Meshing-Purging",
|
||||||
|
"updates": true
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# Copyright (C) 2026 Paul Sharman <github.com/PEEKYPAUL> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# It integrates Moongate for Klipper: #
|
||||||
|
# https://github.com/PEEKYPAUL/Moongate #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
# repository
|
||||||
|
MOONGATE_REPO = "https://github.com/PEEKYPAUL/moongate.git"
|
||||||
|
MOONGATE_REPO_URL = "https://github.com/PEEKYPAUL/Moongate"
|
||||||
|
|
||||||
|
# directories
|
||||||
|
MODULE_PATH = Path(__file__).resolve().parent
|
||||||
|
MOONGATE_DIR = Path.home().joinpath("moongate")
|
||||||
|
MOONGATE_PLUGIN_DIR = MOONGATE_DIR.joinpath("klipper-plugin")
|
||||||
|
|
||||||
|
# installer scripts shipped inside the cloned repo
|
||||||
|
MOONGATE_INSTALL_SCRIPT = MOONGATE_PLUGIN_DIR.joinpath("install.sh")
|
||||||
|
MOONGATE_UPDATE_SCRIPT = MOONGATE_PLUGIN_DIR.joinpath("update.sh")
|
||||||
|
MOONGATE_UNINSTALL_SCRIPT = MOONGATE_PLUGIN_DIR.joinpath("uninstall.sh")
|
||||||
|
|
||||||
|
# moonraker.conf sections the installer manages
|
||||||
|
MOONGATE_UPDATER_NAME = "update_manager moongate"
|
||||||
|
MOONGATE_CONFIG_SECTION = "moongate"
|
||||||
|
|
||||||
|
# default HTTP port the Mainsail/Fluidd UI is served on
|
||||||
|
MOONGATE_DEFAULT_PORT = 80
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
{
|
||||||
|
"metadata": {
|
||||||
|
"index": 16,
|
||||||
|
"module": "moongate_extension",
|
||||||
|
"maintained_by": "PEEKYPAUL",
|
||||||
|
"display_name": "Moongate for Klipper",
|
||||||
|
"description": [
|
||||||
|
"Pair this printer with the Moongate Android app for secure remote",
|
||||||
|
"access and print monitoring. Installs cloudflared, a Cloudflare",
|
||||||
|
"quick-tunnel and an EdDSA auth gate in front of Moonraker."
|
||||||
|
],
|
||||||
|
"repo": "https://github.com/PEEKYPAUL/Moongate",
|
||||||
|
"updates": true
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,249 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# Copyright (C) 2026 Paul Sharman <github.com/PEEKYPAUL> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# It integrates Moongate for Klipper: #
|
||||||
|
# https://github.com/PEEKYPAUL/Moongate #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from pathlib import Path
|
||||||
|
from subprocess import CalledProcessError, run
|
||||||
|
from typing import Dict, List
|
||||||
|
|
||||||
|
from components.moonraker.moonraker import Moonraker
|
||||||
|
from core.instance_manager.instance_manager import InstanceManager
|
||||||
|
from core.logger import DialogType, Logger
|
||||||
|
from core.services.backup_service import BackupService
|
||||||
|
from extensions.base_extension import BaseExtension
|
||||||
|
from extensions.moongate import (
|
||||||
|
MOONGATE_CONFIG_SECTION,
|
||||||
|
MOONGATE_DEFAULT_PORT,
|
||||||
|
MOONGATE_DIR,
|
||||||
|
MOONGATE_INSTALL_SCRIPT,
|
||||||
|
MOONGATE_REPO,
|
||||||
|
MOONGATE_REPO_URL,
|
||||||
|
MOONGATE_UNINSTALL_SCRIPT,
|
||||||
|
MOONGATE_UPDATE_SCRIPT,
|
||||||
|
MOONGATE_UPDATER_NAME,
|
||||||
|
)
|
||||||
|
from utils.config_utils import remove_config_section
|
||||||
|
from utils.fs_utils import check_file_exist
|
||||||
|
from utils.git_utils import GitException, git_clone_wrapper, git_pull_wrapper
|
||||||
|
from utils.input_utils import get_confirm, get_number_input
|
||||||
|
from utils.instance_utils import get_instances
|
||||||
|
|
||||||
|
|
||||||
|
# noinspection PyMethodMayBeStatic
|
||||||
|
class MoongateExtension(BaseExtension):
|
||||||
|
"""
|
||||||
|
Moongate ships a substantial, security-sensitive and idempotent installer
|
||||||
|
(cloudflared, two systemd services, an EdDSA auth proxy, a Moonraker host
|
||||||
|
rebind and a tightly-scoped Avahi sudoers entry). Rather than mirror all
|
||||||
|
of that in Python — where it would drift out of sync with upstream — this
|
||||||
|
extension does the KIAUH-idiomatic parts natively (instance discovery,
|
||||||
|
confirmation, moonraker.conf backup, the repo clone wired to the update
|
||||||
|
manager) and delegates the heavy lifting to Moongate's own scripts.
|
||||||
|
"""
|
||||||
|
|
||||||
|
def install_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Installing Moongate for Klipper ...")
|
||||||
|
|
||||||
|
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||||
|
if not mr_instances:
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.WARNING,
|
||||||
|
[
|
||||||
|
"No Moonraker instances found!",
|
||||||
|
"Moongate is a Moonraker component and needs Moonraker to be "
|
||||||
|
"installed first. Please install Moonraker, then try again.",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
|
# Moongate is a single-printer integration. On a multi-instance host we
|
||||||
|
# target the first Moonraker instance and say so.
|
||||||
|
moonraker = mr_instances[0]
|
||||||
|
if len(mr_instances) > 1:
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.WARNING,
|
||||||
|
[
|
||||||
|
"Multiple Moonraker instances detected.",
|
||||||
|
"Moongate currently supports a single-printer setup. The "
|
||||||
|
f"instance '{moonraker.data_dir.name}' will be used.",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
if not self._confirm_install():
|
||||||
|
Logger.print_info("Installation aborted.")
|
||||||
|
return
|
||||||
|
|
||||||
|
port = get_number_input(
|
||||||
|
"HTTP port your Mainsail/Fluidd UI is served on",
|
||||||
|
min_value=1,
|
||||||
|
max_value=65535,
|
||||||
|
default=MOONGATE_DEFAULT_PORT,
|
||||||
|
)
|
||||||
|
if port is None:
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
self._clone_or_update_repo()
|
||||||
|
|
||||||
|
BackupService().backup_moonraker_conf()
|
||||||
|
|
||||||
|
# Hand off to Moongate's own installer. It is idempotent,
|
||||||
|
# non-interactive and env-driven: it installs cloudflared, adds the
|
||||||
|
# two systemd services, patches moonraker.conf and restarts
|
||||||
|
# Moonraker + Klipper itself.
|
||||||
|
self._run_script(
|
||||||
|
MOONGATE_INSTALL_SCRIPT,
|
||||||
|
moonraker,
|
||||||
|
extra_env={"MOONGATE_PORT": str(port)},
|
||||||
|
)
|
||||||
|
except (GitException, CalledProcessError, OSError) as e:
|
||||||
|
Logger.print_error(f"Error during Moongate installation:\n{e}")
|
||||||
|
return
|
||||||
|
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.SUCCESS,
|
||||||
|
[
|
||||||
|
"Moongate installed successfully!",
|
||||||
|
"\n\n",
|
||||||
|
"Next steps:",
|
||||||
|
"● Install the Moongate app on your Android device.",
|
||||||
|
"● Run MOONGATE_PAIR in the Klipper console (or open the pair "
|
||||||
|
"page printed above) and scan the QR code.",
|
||||||
|
"● Updates from now on: Mainsail/Fluidd > Software Updates > Moongate.",
|
||||||
|
],
|
||||||
|
margin_bottom=1,
|
||||||
|
)
|
||||||
|
|
||||||
|
def update_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Updating Moongate for Klipper ...")
|
||||||
|
|
||||||
|
if not check_file_exist(MOONGATE_DIR.joinpath(".git")):
|
||||||
|
Logger.print_info("Moongate does not seem to be installed. Skipping ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||||
|
if not mr_instances:
|
||||||
|
Logger.print_warn("No Moonraker instance found. Skipping ...")
|
||||||
|
return
|
||||||
|
|
||||||
|
try:
|
||||||
|
git_pull_wrapper(MOONGATE_DIR)
|
||||||
|
self._run_script(MOONGATE_UPDATE_SCRIPT, mr_instances[0])
|
||||||
|
InstanceManager.restart_all(mr_instances)
|
||||||
|
except (GitException, CalledProcessError, OSError) as e:
|
||||||
|
Logger.print_error(f"Error during Moongate update:\n{e}")
|
||||||
|
return
|
||||||
|
|
||||||
|
Logger.print_ok("Moongate updated successfully.", end="\n\n")
|
||||||
|
|
||||||
|
def remove_extension(self, **kwargs) -> None:
|
||||||
|
Logger.print_status("Removing Moongate for Klipper ...")
|
||||||
|
|
||||||
|
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||||
|
|
||||||
|
if not get_confirm(
|
||||||
|
"This removes Moongate, cloudflared, both systemd services and all "
|
||||||
|
"Moongate config. Continue?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=True,
|
||||||
|
):
|
||||||
|
Logger.print_info("Removal aborted.")
|
||||||
|
return
|
||||||
|
|
||||||
|
# Preferred path: delegate to Moongate's own uninstaller, which stops
|
||||||
|
# and removes the services, cleans moonraker.conf, restores its backup
|
||||||
|
# and restarts Moonraker. MOONGATE_YES=1 makes it non-interactive
|
||||||
|
# (KIAUH already collected the confirmation above).
|
||||||
|
if check_file_exist(MOONGATE_UNINSTALL_SCRIPT):
|
||||||
|
try:
|
||||||
|
BackupService().backup_moonraker_conf()
|
||||||
|
target = mr_instances[0] if mr_instances else None
|
||||||
|
self._run_script(
|
||||||
|
MOONGATE_UNINSTALL_SCRIPT,
|
||||||
|
target,
|
||||||
|
extra_env={"MOONGATE_YES": "1"},
|
||||||
|
)
|
||||||
|
Logger.print_ok("Moongate removed successfully.")
|
||||||
|
return
|
||||||
|
except (CalledProcessError, OSError) as e:
|
||||||
|
Logger.print_error(f"Error during Moongate removal:\n{e}")
|
||||||
|
# fall through to a best-effort native cleanup
|
||||||
|
|
||||||
|
# Fallback: the upstream uninstaller is gone (repo already deleted).
|
||||||
|
# Do a best-effort native cleanup so moonraker.conf is left consistent.
|
||||||
|
Logger.print_warn(
|
||||||
|
"Moongate uninstaller not found — doing a best-effort cleanup. You "
|
||||||
|
"may need to remove cloudflared and the moongate-* systemd services "
|
||||||
|
"manually."
|
||||||
|
)
|
||||||
|
if mr_instances:
|
||||||
|
BackupService().backup_moonraker_conf()
|
||||||
|
remove_config_section(MOONGATE_UPDATER_NAME, mr_instances)
|
||||||
|
remove_config_section(MOONGATE_CONFIG_SECTION, mr_instances)
|
||||||
|
InstanceManager.restart_all(mr_instances)
|
||||||
|
Logger.print_ok("Moongate configuration removed.")
|
||||||
|
|
||||||
|
# ------------------------------------------------------------------ #
|
||||||
|
# helpers #
|
||||||
|
# ------------------------------------------------------------------ #
|
||||||
|
def _confirm_install(self) -> bool:
|
||||||
|
Logger.print_dialog(
|
||||||
|
DialogType.ATTENTION,
|
||||||
|
[
|
||||||
|
"Moongate pairs this printer with the Moongate Android app for "
|
||||||
|
"secure remote access and print monitoring.",
|
||||||
|
"\n\n",
|
||||||
|
"This is a heavier install than most extensions. It will:",
|
||||||
|
"● clone the Moongate repo to ~/moongate",
|
||||||
|
"● add the Moongate component to Moonraker and register it with "
|
||||||
|
"the update manager",
|
||||||
|
"● install cloudflared and open a Cloudflare quick-tunnel",
|
||||||
|
"● add two systemd services: moongate-authproxy + moongate-tunnel",
|
||||||
|
"● bind Moonraker to 127.0.0.1 (the auth proxy fronts the tunnel)",
|
||||||
|
"● add a tightly-scoped Avahi sudoers entry for LAN discovery",
|
||||||
|
"\n\n",
|
||||||
|
"Remote access relies on cloud infrastructure operated by the "
|
||||||
|
"Moongate author. Moongate is licensed under PolyForm "
|
||||||
|
"Noncommercial 1.0.0 (non-commercial use only).",
|
||||||
|
MOONGATE_REPO_URL,
|
||||||
|
],
|
||||||
|
margin_bottom=1,
|
||||||
|
)
|
||||||
|
return bool(
|
||||||
|
get_confirm(
|
||||||
|
"Continue Moongate installation?",
|
||||||
|
default_choice=True,
|
||||||
|
allow_go_back=True,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
def _clone_or_update_repo(self) -> None:
|
||||||
|
if check_file_exist(MOONGATE_DIR.joinpath(".git")):
|
||||||
|
git_pull_wrapper(MOONGATE_DIR)
|
||||||
|
else:
|
||||||
|
git_clone_wrapper(MOONGATE_REPO, MOONGATE_DIR)
|
||||||
|
|
||||||
|
def _run_script(
|
||||||
|
self,
|
||||||
|
script: Path,
|
||||||
|
moonraker: Moonraker | None,
|
||||||
|
extra_env: Dict[str, str] | None = None,
|
||||||
|
) -> None:
|
||||||
|
env = os.environ.copy()
|
||||||
|
if moonraker is not None:
|
||||||
|
env["MOONRAKER_DIR"] = moonraker.moonraker_dir.as_posix()
|
||||||
|
env["PRINTER_DATA"] = moonraker.data_dir.as_posix()
|
||||||
|
if extra_env:
|
||||||
|
env.update(extra_env)
|
||||||
|
run(["bash", script.as_posix()], env=env, check=True)
|
||||||
@@ -1,5 +1,6 @@
|
|||||||
# ======================================================================= #
|
# ======================================================================= #
|
||||||
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# Copyright (C) 2026 Théo Gaillard <theo.gayar@gmail.com> #
|
||||||
# #
|
# #
|
||||||
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
# https://github.com/dw-0/kiauh #
|
# https://github.com/dw-0/kiauh #
|
||||||
@@ -82,7 +83,7 @@ class TmcAutotuneExtension(BaseExtension):
|
|||||||
allow_go_back=False,
|
allow_go_back=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
kl_instances = get_instances(Klipper)
|
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||||
|
|
||||||
if not stop_klipper_instances_interactively(
|
if not stop_klipper_instances_interactively(
|
||||||
kl_instances, "installation of TMC Autotune"
|
kl_instances, "installation of TMC Autotune"
|
||||||
@@ -120,7 +121,7 @@ class TmcAutotuneExtension(BaseExtension):
|
|||||||
)
|
)
|
||||||
|
|
||||||
if add_moonraker_update_section:
|
if add_moonraker_update_section:
|
||||||
mr_instances = get_instances(Moonraker)
|
mr_instances: List[Moonraker] = get_instances(Moonraker)
|
||||||
self._add_moonraker_update_manager_section(mr_instances)
|
self._add_moonraker_update_manager_section(mr_instances)
|
||||||
else:
|
else:
|
||||||
Logger.print_info(
|
Logger.print_info(
|
||||||
@@ -170,7 +171,7 @@ class TmcAutotuneExtension(BaseExtension):
|
|||||||
allow_go_back=True,
|
allow_go_back=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
kl_instances = get_instances(Klipper)
|
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||||
|
|
||||||
if not stop_klipper_instances_interactively(
|
if not stop_klipper_instances_interactively(
|
||||||
kl_instances, "update of TMC Autotune"
|
kl_instances, "update of TMC Autotune"
|
||||||
@@ -208,7 +209,7 @@ class TmcAutotuneExtension(BaseExtension):
|
|||||||
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
||||||
return
|
return
|
||||||
|
|
||||||
kl_instances = get_instances(Klipper)
|
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||||
|
|
||||||
if not stop_klipper_instances_interactively(
|
if not stop_klipper_instances_interactively(
|
||||||
kl_instances, "removal of TMC Autotune"
|
kl_instances, "removal of TMC Autotune"
|
||||||
@@ -344,4 +345,3 @@ class TmcAutotuneExtension(BaseExtension):
|
|||||||
Logger.print_ok(
|
Logger.print_ok(
|
||||||
"Klipper TMC Autotune successfully removed from Moonraker update manager(s)!"
|
"Klipper TMC Autotune successfully removed from Moonraker update manager(s)!"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,93 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import socket
|
||||||
|
from ipaddress import ip_address
|
||||||
|
from typing import List, Set
|
||||||
|
|
||||||
|
|
||||||
|
class UnsafeTargetError(Exception):
|
||||||
|
"""Raised when a live test target is considered unsafe."""
|
||||||
|
|
||||||
|
|
||||||
|
LOCAL_HOSTNAMES = {"localhost", "localhost.localdomain"}
|
||||||
|
LOCAL_ADDRESSES = {"127.0.0.1", "::1"}
|
||||||
|
|
||||||
|
|
||||||
|
def _local_interface_ips() -> Set[str]:
|
||||||
|
"""Return all IP addresses assigned to local network interfaces."""
|
||||||
|
ips: Set[str] = set()
|
||||||
|
try:
|
||||||
|
hostname = socket.gethostname()
|
||||||
|
infos = socket.getaddrinfo(hostname, None)
|
||||||
|
for info in infos:
|
||||||
|
addr = info[4][0]
|
||||||
|
ips.add(addr)
|
||||||
|
except socket.gaierror:
|
||||||
|
pass
|
||||||
|
return ips
|
||||||
|
|
||||||
|
|
||||||
|
def _resolve(host: str) -> List[str]:
|
||||||
|
"""Resolve a hostname to its IP addresses."""
|
||||||
|
try:
|
||||||
|
infos = socket.getaddrinfo(host, None)
|
||||||
|
return [info[4][0] for info in infos]
|
||||||
|
except socket.gaierror:
|
||||||
|
return []
|
||||||
|
|
||||||
|
|
||||||
|
def is_local_host(host: str) -> bool:
|
||||||
|
"""Return True if the host refers to the local machine."""
|
||||||
|
host_lower = host.lower().strip()
|
||||||
|
|
||||||
|
if host_lower in LOCAL_HOSTNAMES:
|
||||||
|
return True
|
||||||
|
|
||||||
|
if host_lower in LOCAL_ADDRESSES:
|
||||||
|
return True
|
||||||
|
|
||||||
|
if host_lower == socket.gethostname().lower():
|
||||||
|
return True
|
||||||
|
|
||||||
|
resolved = _resolve(host_lower)
|
||||||
|
local_ips = _local_interface_ips() | LOCAL_ADDRESSES
|
||||||
|
for addr in resolved:
|
||||||
|
if addr in local_ips:
|
||||||
|
return True
|
||||||
|
try:
|
||||||
|
if ip_address(addr).is_loopback:
|
||||||
|
return True
|
||||||
|
except ValueError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def assert_safe_to_run(vm) -> None:
|
||||||
|
"""Multi-layer safety check before running live tests against a VM."""
|
||||||
|
if os.environ.get("KIAUH_LIVE_ALLOW") != "1":
|
||||||
|
raise UnsafeTargetError(
|
||||||
|
"Live tests disabled. Set KIAUH_LIVE_ALLOW=1 to enable."
|
||||||
|
)
|
||||||
|
|
||||||
|
if not vm.host:
|
||||||
|
raise UnsafeTargetError("VM host is empty")
|
||||||
|
|
||||||
|
if is_local_host(vm.host):
|
||||||
|
raise UnsafeTargetError(
|
||||||
|
f"Refusing to run live tests against local host: {vm.host}"
|
||||||
|
)
|
||||||
|
|
||||||
|
if os.environ.get("KIAUH_LIVE_TARGET_HOST") != vm.host:
|
||||||
|
raise UnsafeTargetError(
|
||||||
|
"KIAUH_LIVE_TARGET_HOST must match the selected VM host"
|
||||||
|
)
|
||||||
@@ -0,0 +1,90 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
from dataclasses import dataclass
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
try:
|
||||||
|
from dotenv import load_dotenv
|
||||||
|
|
||||||
|
load_dotenv(Path(__file__).parents[2].joinpath(".env"))
|
||||||
|
except ImportError:
|
||||||
|
load_dotenv = None
|
||||||
|
|
||||||
|
DEFAULT_INVENTORY_PATH = Path(__file__).parent.joinpath("inventory.yaml")
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class VM:
|
||||||
|
name: str
|
||||||
|
host: str
|
||||||
|
user: str
|
||||||
|
key_file: str
|
||||||
|
os: str
|
||||||
|
domain: str | None = None
|
||||||
|
snapshot: str | None = None
|
||||||
|
|
||||||
|
|
||||||
|
class InventoryError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def _env_var_name(vm_name: str, suffix: str) -> str:
|
||||||
|
safe_name = vm_name.replace("-", "_").upper()
|
||||||
|
return f"KIAUH_LIVE_{safe_name}_{suffix.upper()}"
|
||||||
|
|
||||||
|
|
||||||
|
def load_inventory(path: Path | None = None) -> List[VM]:
|
||||||
|
inventory_path = Path(path or os.environ.get("KIAUH_LIVE_INVENTORY", DEFAULT_INVENTORY_PATH))
|
||||||
|
if not inventory_path.exists():
|
||||||
|
raise InventoryError(f"Inventory file not found: {inventory_path}")
|
||||||
|
|
||||||
|
data = yaml.safe_load(inventory_path.read_text())
|
||||||
|
if not data or "vms" not in data:
|
||||||
|
raise InventoryError("Inventory must contain a 'vms' list")
|
||||||
|
|
||||||
|
vms = []
|
||||||
|
for item in data["vms"]:
|
||||||
|
for required in ("name", "user", "os"):
|
||||||
|
if required not in item:
|
||||||
|
raise InventoryError(f"VM '{item.get('name', '?')}' missing '{required}'")
|
||||||
|
|
||||||
|
name = item["name"]
|
||||||
|
host = os.environ.get(_env_var_name(name, "host"), item.get("host"))
|
||||||
|
key_file = os.environ.get(_env_var_name(name, "key_file"), item.get("key_file"))
|
||||||
|
|
||||||
|
if not host:
|
||||||
|
raise InventoryError(f"VM '{name}' missing 'host' (inventory or env)")
|
||||||
|
if not key_file:
|
||||||
|
raise InventoryError(f"VM '{name}' missing 'key_file' (inventory or env)")
|
||||||
|
|
||||||
|
vms.append(
|
||||||
|
VM(
|
||||||
|
name=name,
|
||||||
|
host=host,
|
||||||
|
user=item["user"],
|
||||||
|
key_file=key_file,
|
||||||
|
os=item["os"],
|
||||||
|
domain=item.get("domain"),
|
||||||
|
snapshot=item.get("snapshot"),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
return vms
|
||||||
|
|
||||||
|
|
||||||
|
def get_vm(name: str, path: Path | None = None) -> VM:
|
||||||
|
for vm in load_inventory(path):
|
||||||
|
if vm.name == name:
|
||||||
|
return vm
|
||||||
|
raise InventoryError(f"VM '{name}' not found in inventory")
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
vms:
|
||||||
|
- name: debian12-kiauh
|
||||||
|
# Override host/key_file via environment variables or a .env file.
|
||||||
|
# KIAUH_LIVE_DEBIAN12_KIAUH_HOST
|
||||||
|
# KIAUH_LIVE_DEBIAN12_KIAUH_KEY_FILE
|
||||||
|
host: null
|
||||||
|
user: kiauh
|
||||||
|
key_file: null
|
||||||
|
os: debian-12
|
||||||
|
domain: debian12-kiauh
|
||||||
|
snapshot: clean
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import subprocess
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
import paramiko
|
||||||
|
import testinfra
|
||||||
|
|
||||||
|
from live.guards import assert_safe_to_run, is_local_host
|
||||||
|
from live.inventory import VM
|
||||||
|
|
||||||
|
|
||||||
|
class LiveRunnerError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
class LiveRunner:
|
||||||
|
"""SSH runner for live VM tests."""
|
||||||
|
|
||||||
|
def __init__(self, vm: VM) -> None:
|
||||||
|
assert_safe_to_run(vm)
|
||||||
|
self.vm = vm
|
||||||
|
self._ssh: paramiko.SSHClient | None = None
|
||||||
|
|
||||||
|
def connect(self) -> paramiko.SSHClient:
|
||||||
|
if self._ssh is not None:
|
||||||
|
return self._ssh
|
||||||
|
|
||||||
|
client = paramiko.SSHClient()
|
||||||
|
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
|
||||||
|
key_file = Path(self.vm.key_file).expanduser()
|
||||||
|
client.connect(
|
||||||
|
self.vm.host,
|
||||||
|
username=self.vm.user,
|
||||||
|
key_filename=str(key_file),
|
||||||
|
look_for_keys=False,
|
||||||
|
timeout=30,
|
||||||
|
)
|
||||||
|
self._ssh = client
|
||||||
|
return client
|
||||||
|
|
||||||
|
def run(self, command: List[str], timeout: int = 120) -> subprocess.CompletedProcess:
|
||||||
|
client = self.connect()
|
||||||
|
cmd = " ".join(command) if isinstance(command, list) else command
|
||||||
|
stdin, stdout, stderr = client.exec_command(cmd, timeout=timeout)
|
||||||
|
rc = stdout.channel.recv_exit_status()
|
||||||
|
return subprocess.CompletedProcess(
|
||||||
|
args=command,
|
||||||
|
returncode=rc,
|
||||||
|
stdout=stdout.read().decode("utf-8", errors="replace"),
|
||||||
|
stderr=stderr.read().decode("utf-8", errors="replace"),
|
||||||
|
)
|
||||||
|
|
||||||
|
def get_host(self) -> testinfra.host.Host:
|
||||||
|
"""Return a Testinfra host for assertions."""
|
||||||
|
key_file = Path(self.vm.key_file).expanduser()
|
||||||
|
return testinfra.get_host(
|
||||||
|
f"paramiko://{self.vm.user}@{self.vm.host}",
|
||||||
|
ssh_identity_file=str(key_file),
|
||||||
|
)
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
if self._ssh is not None:
|
||||||
|
self._ssh.close()
|
||||||
|
self._ssh = None
|
||||||
|
|
||||||
|
|
||||||
|
def revert_vm_snapshot(vm: VM) -> None:
|
||||||
|
"""Revert a VM to the configured snapshot before a scenario."""
|
||||||
|
if not vm.domain or not vm.snapshot:
|
||||||
|
raise LiveRunnerError("VM inventory missing domain or snapshot")
|
||||||
|
|
||||||
|
if is_local_host(vm.host):
|
||||||
|
raise LiveRunnerError("Refusing to revert a local VM snapshot")
|
||||||
|
|
||||||
|
result = subprocess.run(
|
||||||
|
["virsh", "snapshot-revert", vm.domain, vm.snapshot, "--running"],
|
||||||
|
capture_output=True,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
raise LiveRunnerError(
|
||||||
|
f"Failed to revert snapshot: {result.stderr.strip() or result.stdout.strip()}"
|
||||||
|
)
|
||||||
@@ -0,0 +1,85 @@
|
|||||||
|
# ======================================================================= #
|
||||||
|
# Copyright (C) 2020 - 2026 Dominik Willner <th33xitus@gmail.com> #
|
||||||
|
# #
|
||||||
|
# This file is part of KIAUH - Klipper Installation And Update Helper #
|
||||||
|
# https://github.com/dw-0/kiauh #
|
||||||
|
# #
|
||||||
|
# This file may be distributed under the terms of the GNU GPLv3 license #
|
||||||
|
# ======================================================================= #
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Dict, List
|
||||||
|
|
||||||
|
import yaml
|
||||||
|
|
||||||
|
SCENARIOS_DIR = Path(__file__).parent.joinpath("scenarios")
|
||||||
|
|
||||||
|
|
||||||
|
class ScenarioError(Exception):
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
def load_scenarios(directory: Path | None = None) -> List[Dict[str, Any]]:
|
||||||
|
path = Path(directory or SCENARIOS_DIR)
|
||||||
|
if not path.exists():
|
||||||
|
return []
|
||||||
|
|
||||||
|
scenarios = []
|
||||||
|
for file in sorted(path.glob("*.yaml")):
|
||||||
|
data = yaml.safe_load(file.read_text())
|
||||||
|
if not isinstance(data, dict):
|
||||||
|
raise ScenarioError(f"Scenario {file.name} is not a mapping")
|
||||||
|
data.setdefault("file", str(file))
|
||||||
|
scenarios.append(data)
|
||||||
|
return scenarios
|
||||||
|
|
||||||
|
|
||||||
|
def assert_expected(host, expected: List[Dict[str, Any]]) -> None:
|
||||||
|
"""Evaluate expected outcomes using Testinfra assertions."""
|
||||||
|
failures = []
|
||||||
|
|
||||||
|
for item in expected:
|
||||||
|
try:
|
||||||
|
_assert_item(host, item)
|
||||||
|
except AssertionError as e:
|
||||||
|
failures.append(f"{item}: {e}")
|
||||||
|
|
||||||
|
if failures:
|
||||||
|
raise AssertionError("\n".join(failures))
|
||||||
|
|
||||||
|
|
||||||
|
def _assert_item(host, item: Dict[str, Any]) -> None:
|
||||||
|
assertion_type = item.get("type")
|
||||||
|
|
||||||
|
if assertion_type == "service":
|
||||||
|
service = host.service(item["name"])
|
||||||
|
state = item.get("state")
|
||||||
|
if state == "running":
|
||||||
|
assert service.is_running, f"service {item['name']} is not running"
|
||||||
|
elif state == "enabled":
|
||||||
|
assert service.is_enabled, f"service {item['name']} is not enabled"
|
||||||
|
|
||||||
|
elif assertion_type == "file":
|
||||||
|
file = host.file(item["path"])
|
||||||
|
if item.get("exists", True):
|
||||||
|
assert file.exists, f"file {item['path']} does not exist"
|
||||||
|
else:
|
||||||
|
assert not file.exists, f"file {item['path']} should not exist"
|
||||||
|
|
||||||
|
elif assertion_type == "package":
|
||||||
|
pkg = host.package(item["name"])
|
||||||
|
assert pkg.is_installed, f"package {item['name']} is not installed"
|
||||||
|
|
||||||
|
elif assertion_type == "port":
|
||||||
|
socket = host.socket(f"tcp://{item['address']}:{item['port']}")
|
||||||
|
assert socket.is_listening, f"port {item['port']} is not listening"
|
||||||
|
|
||||||
|
elif assertion_type == "command":
|
||||||
|
result = host.run(item["command"])
|
||||||
|
assert result.rc == item.get("returncode", 0), (
|
||||||
|
f"command {item['command']} returned {result.rc}: {result.stderr}"
|
||||||
|
)
|
||||||
|
|
||||||
|
else:
|
||||||
|
raise ScenarioError(f"Unknown assertion type: {assertion_type}")
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
name: Backup and restore Klipper data on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["mkdir", "-p", "/home/kiauh/backups"]
|
||||||
|
timeout: 10
|
||||||
|
- command: ["tar", "-czf", "/home/kiauh/backups/printer_data.tar.gz", "-C", "/home/kiauh", "printer_data"]
|
||||||
|
timeout: 60
|
||||||
|
- command: ["rm", "-rf", "/home/kiauh/printer_data"]
|
||||||
|
timeout: 30
|
||||||
|
- command: ["tar", "-xzf", "/home/kiauh/backups/printer_data.tar.gz", "-C", "/home/kiauh"]
|
||||||
|
timeout: 60
|
||||||
|
expected:
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/backups/printer_data.tar.gz
|
||||||
|
exists: true
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/printer_data
|
||||||
|
exists: true
|
||||||
|
- type: service
|
||||||
|
name: klipper.service
|
||||||
|
state: running
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
name: Install Klipper on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["sudo", "systemctl", "is-active", "klipper.service"]
|
||||||
|
timeout: 30
|
||||||
|
expected:
|
||||||
|
- type: service
|
||||||
|
name: klipper.service
|
||||||
|
state: running
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/klipper/klipper
|
||||||
|
exists: true
|
||||||
|
- type: command
|
||||||
|
command: systemctl is-enabled klipper.service
|
||||||
|
returncode: 0
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
name: Remove Klipper on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["kiauh", "remove", "klipper", "--service", "--dir", "--env"]
|
||||||
|
timeout: 120
|
||||||
|
expected:
|
||||||
|
- type: file
|
||||||
|
path: /etc/systemd/system/klipper.service
|
||||||
|
exists: false
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/klipper
|
||||||
|
exists: false
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/klippy-env
|
||||||
|
exists: false
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
name: Update Klipper on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["kiauh", "update", "klipper"]
|
||||||
|
timeout: 300
|
||||||
|
expected:
|
||||||
|
- type: service
|
||||||
|
name: klipper.service
|
||||||
|
state: running
|
||||||
|
- type: command
|
||||||
|
command: test -d /home/kiauh/klipper/.git
|
||||||
|
returncode: 0
|
||||||
@@ -0,0 +1,15 @@
|
|||||||
|
name: Install Moonraker on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["kiauh", "install", "moonraker"]
|
||||||
|
timeout: 600
|
||||||
|
expected:
|
||||||
|
- type: service
|
||||||
|
name: moonraker.service
|
||||||
|
state: running
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/moonraker/moonraker
|
||||||
|
exists: true
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
name: Remove Moonraker on Debian 12
|
||||||
|
vm: debian12-kiauh
|
||||||
|
os: debian-12
|
||||||
|
steps:
|
||||||
|
- command: ["kiauh", "install", "klipper", "--count", "1"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["kiauh", "install", "moonraker"]
|
||||||
|
timeout: 600
|
||||||
|
- command: ["kiauh", "remove", "moonraker", "--service", "--dir", "--env"]
|
||||||
|
timeout: 120
|
||||||
|
expected:
|
||||||
|
- type: file
|
||||||
|
path: /etc/systemd/system/moonraker.service
|
||||||
|
exists: false
|
||||||
|
- type: file
|
||||||
|
path: /home/kiauh/moonraker
|
||||||
|
exists: false
|
||||||
@@ -0,0 +1,74 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import Any, Dict, Generator, List
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
PROJECT_ROOT = Path(__file__).resolve().parents[3]
|
||||||
|
if str(PROJECT_ROOT) not in sys.path:
|
||||||
|
sys.path.insert(0, str(PROJECT_ROOT))
|
||||||
|
|
||||||
|
from live.inventory import VM, get_vm
|
||||||
|
from live.runner import LiveRunner, revert_vm_snapshot
|
||||||
|
from live.scenarios import load_scenarios
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def silence_logger(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
for name in (
|
||||||
|
"print_info",
|
||||||
|
"print_ok",
|
||||||
|
"print_warn",
|
||||||
|
"print_error",
|
||||||
|
"print_status",
|
||||||
|
"print_dialog",
|
||||||
|
):
|
||||||
|
monkeypatch.setattr(f"core.logger.Logger.{name}", lambda *a, **k: None)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_configure(config: pytest.Config) -> None:
|
||||||
|
config.addinivalue_line(
|
||||||
|
"markers",
|
||||||
|
"live: tests that run against a real VM (isolated, never local)",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_collection_modifyitems(config: pytest.Config, items: List[pytest.Item]) -> None:
|
||||||
|
skip_live = pytest.mark.skip(reason="live tests skipped by default; use -m live")
|
||||||
|
for item in items:
|
||||||
|
if item.get_closest_marker("live") and not config.getoption("-m"):
|
||||||
|
item.add_marker(skip_live)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="session")
|
||||||
|
def live_vm() -> VM:
|
||||||
|
"""Single VM used for live tests."""
|
||||||
|
vm_name = os.environ.get("KIAUH_LIVE_VM", "debian12-kiauh")
|
||||||
|
return get_vm(vm_name)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="function")
|
||||||
|
def live_runner(live_vm: VM) -> Generator[LiveRunner, None, None]:
|
||||||
|
runner = LiveRunner(live_vm)
|
||||||
|
yield runner
|
||||||
|
runner.close()
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(scope="function")
|
||||||
|
def fresh_vm(live_vm: VM) -> VM:
|
||||||
|
"""Revert the VM to its clean snapshot before each scenario."""
|
||||||
|
revert_vm_snapshot(live_vm)
|
||||||
|
return live_vm
|
||||||
|
|
||||||
|
|
||||||
|
def pytest_generate_tests(metafunc: pytest.Metafunc) -> None:
|
||||||
|
if "scenario" in metafunc.fixturenames:
|
||||||
|
scenarios = load_scenarios()
|
||||||
|
metafunc.parametrize(
|
||||||
|
"scenario",
|
||||||
|
scenarios,
|
||||||
|
ids=[s.get("name", s.get("file", "unknown")) for s in scenarios],
|
||||||
|
)
|
||||||
@@ -0,0 +1,55 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import socket
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from live.guards import UnsafeTargetError, assert_safe_to_run, is_local_host
|
||||||
|
from live.inventory import VM
|
||||||
|
|
||||||
|
|
||||||
|
class TestIsLocalHost:
|
||||||
|
def test_localhost_is_local(self) -> None:
|
||||||
|
assert is_local_host("localhost") is True
|
||||||
|
|
||||||
|
def test_127_is_local(self) -> None:
|
||||||
|
assert is_local_host("127.0.0.1") is True
|
||||||
|
assert is_local_host("::1") is True
|
||||||
|
|
||||||
|
def test_current_hostname_is_local(self) -> None:
|
||||||
|
assert is_local_host(socket.gethostname()) is True
|
||||||
|
|
||||||
|
def test_remote_host_is_not_local(self) -> None:
|
||||||
|
assert is_local_host("192.168.122.10") is False
|
||||||
|
assert is_local_host("example.com") is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestAssertSafeToRun:
|
||||||
|
def test_requires_live_allow_flag(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.delenv("KIAUH_LIVE_ALLOW", raising=False)
|
||||||
|
vm = VM(name="vm", host="192.168.122.10", user="u", key_file="k", os="debian-12")
|
||||||
|
|
||||||
|
with pytest.raises(UnsafeTargetError, match="disabled"):
|
||||||
|
assert_safe_to_run(vm)
|
||||||
|
|
||||||
|
def test_blocks_localhost(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_ALLOW", "1")
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_TARGET_HOST", "localhost")
|
||||||
|
vm = VM(name="vm", host="localhost", user="u", key_file="k", os="debian-12")
|
||||||
|
|
||||||
|
with pytest.raises(UnsafeTargetError, match="local host"):
|
||||||
|
assert_safe_to_run(vm)
|
||||||
|
|
||||||
|
def test_requires_matching_target_host(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_ALLOW", "1")
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_TARGET_HOST", "192.168.122.10")
|
||||||
|
vm = VM(name="vm", host="192.168.122.11", user="u", key_file="k", os="debian-12")
|
||||||
|
|
||||||
|
with pytest.raises(UnsafeTargetError, match="must match"):
|
||||||
|
assert_safe_to_run(vm)
|
||||||
|
|
||||||
|
def test_passes_for_safe_remote_host(self, monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_ALLOW", "1")
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_TARGET_HOST", "192.168.122.10")
|
||||||
|
vm = VM(name="vm", host="192.168.122.10", user="u", key_file="k", os="debian-12")
|
||||||
|
|
||||||
|
assert assert_safe_to_run(vm) is None
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from live.inventory import InventoryError, VM, load_inventory
|
||||||
|
|
||||||
|
|
||||||
|
class TestLoadInventory:
|
||||||
|
def test_loads_vm_from_inventory(self, tmp_path: Path) -> None:
|
||||||
|
inv = tmp_path / "inv.yaml"
|
||||||
|
inv.write_text(
|
||||||
|
"vms:\n"
|
||||||
|
" - name: debian12\n"
|
||||||
|
" host: 10.0.0.5\n"
|
||||||
|
" user: kiauh\n"
|
||||||
|
" key_file: /key\n"
|
||||||
|
" os: debian-12\n"
|
||||||
|
)
|
||||||
|
vms = load_inventory(inv)
|
||||||
|
assert len(vms) == 1
|
||||||
|
assert vms[0].host == "10.0.0.5"
|
||||||
|
assert vms[0].key_file == "/key"
|
||||||
|
|
||||||
|
def test_env_overrides_host_and_key_file(
|
||||||
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_DEBIAN12_HOST", "192.168.1.50")
|
||||||
|
monkeypatch.setenv("KIAUH_LIVE_DEBIAN12_KEY_FILE", "/secret/key")
|
||||||
|
|
||||||
|
inv = tmp_path / "inv.yaml"
|
||||||
|
inv.write_text(
|
||||||
|
"vms:\n"
|
||||||
|
" - name: debian12\n"
|
||||||
|
" host: 10.0.0.5\n"
|
||||||
|
" user: kiauh\n"
|
||||||
|
" key_file: /key\n"
|
||||||
|
" os: debian-12\n"
|
||||||
|
)
|
||||||
|
vms = load_inventory(inv)
|
||||||
|
assert vms[0].host == "192.168.1.50"
|
||||||
|
assert vms[0].key_file == "/secret/key"
|
||||||
|
|
||||||
|
def test_missing_host_raises(self, tmp_path: Path) -> None:
|
||||||
|
inv = tmp_path / "inv.yaml"
|
||||||
|
inv.write_text(
|
||||||
|
"vms:\n"
|
||||||
|
" - name: debian12\n"
|
||||||
|
" user: kiauh\n"
|
||||||
|
" key_file: /key\n"
|
||||||
|
" os: debian-12\n"
|
||||||
|
)
|
||||||
|
with pytest.raises(InventoryError, match="missing 'host'"):
|
||||||
|
load_inventory(inv)
|
||||||
@@ -0,0 +1,27 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any, Dict, List
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
from live.inventory import VM
|
||||||
|
from live.runner import LiveRunner
|
||||||
|
from live.scenarios import assert_expected
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.live
|
||||||
|
def test_scenario(fresh_vm: VM, live_runner: LiveRunner, scenario: Dict[str, Any]) -> None:
|
||||||
|
"""Run a live scenario against the VM and verify expected outcomes."""
|
||||||
|
steps: List[Dict[str, Any]] = scenario.get("steps", [])
|
||||||
|
expected = scenario.get("expected", [])
|
||||||
|
|
||||||
|
for step in steps:
|
||||||
|
command = step["command"]
|
||||||
|
timeout = step.get("timeout", 120)
|
||||||
|
result = live_runner.run(command, timeout=timeout)
|
||||||
|
assert result.returncode == 0, (
|
||||||
|
f"Step failed: {' '.join(command)}\nstdout: {result.stdout}\nstderr: {result.stderr}"
|
||||||
|
)
|
||||||
|
|
||||||
|
host = live_runner.get_host()
|
||||||
|
assert_expected(host, expected)
|
||||||
@@ -31,6 +31,7 @@ from components.moonraker.services.moonraker_setup_service import (
|
|||||||
from core.instance_manager.instance_manager import InstanceManager
|
from core.instance_manager.instance_manager import InstanceManager
|
||||||
from core.logger import Logger
|
from core.logger import Logger
|
||||||
from core.services.backup_service import BackupService
|
from core.services.backup_service import BackupService
|
||||||
|
from core.settings.kiauh_settings import KiauhSettings
|
||||||
from utils.git_utils import GitException, git_clone_wrapper
|
from utils.git_utils import GitException, git_clone_wrapper
|
||||||
from utils.instance_utils import get_instances
|
from utils.instance_utils import get_instances
|
||||||
from utils.sys_utils import (
|
from utils.sys_utils import (
|
||||||
@@ -47,6 +48,11 @@ class RepoSwitchFailedException(Exception):
|
|||||||
def run_switch_repo_routine(
|
def run_switch_repo_routine(
|
||||||
name: Literal["klipper", "moonraker"], repo_url: str, branch: str
|
name: Literal["klipper", "moonraker"], repo_url: str, branch: str
|
||||||
) -> None:
|
) -> None:
|
||||||
|
if name not in ("klipper", "moonraker"):
|
||||||
|
raise ValueError(
|
||||||
|
f"Invalid name: {name!r}. Must be 'klipper' or 'moonraker'."
|
||||||
|
)
|
||||||
|
|
||||||
repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
|
repo_dir: Path = KLIPPER_DIR if name == "klipper" else MOONRAKER_DIR
|
||||||
env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
|
env_dir: Path = KLIPPER_ENV_DIR if name == "klipper" else MOONRAKER_ENV_DIR
|
||||||
req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
|
req_file = KLIPPER_REQ_FILE if name == "klipper" else MOONRAKER_REQ_FILE
|
||||||
@@ -89,7 +95,16 @@ def run_switch_repo_routine(
|
|||||||
|
|
||||||
# step 6: recreate python virtualenv
|
# step 6: recreate python virtualenv
|
||||||
Logger.print_status(f"Recreating {_type.__name__} virtualenv ...")
|
Logger.print_status(f"Recreating {_type.__name__} virtualenv ...")
|
||||||
if not create_python_venv(env_dir, force=True):
|
|
||||||
|
settings = KiauhSettings()
|
||||||
|
if name == "klipper":
|
||||||
|
use_python_binary = settings.klipper.use_python_binary
|
||||||
|
elif name == "moonraker":
|
||||||
|
use_python_binary = settings.moonraker.use_python_binary
|
||||||
|
|
||||||
|
if not create_python_venv(
|
||||||
|
env_dir, force=True, use_python_binary=use_python_binary
|
||||||
|
):
|
||||||
raise GitException(f"Failed to recreate virtualenv for {_type.__name__}")
|
raise GitException(f"Failed to recreate virtualenv for {_type.__name__}")
|
||||||
else:
|
else:
|
||||||
install_python_requirements(env_dir, req_file)
|
install_python_requirements(env_dir, req_file)
|
||||||
|
|||||||
@@ -36,13 +36,15 @@ from utils.sys_utils import (
|
|||||||
update_system_package_lists,
|
update_system_package_lists,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
from kiauh import PROJECT_ROOT
|
||||||
|
|
||||||
|
|
||||||
def get_kiauh_version() -> str:
|
def get_kiauh_version() -> str:
|
||||||
"""
|
"""
|
||||||
Helper method to get the current KIAUH version by reading the latest tag
|
Helper method to get the current KIAUH version by reading the latest tag
|
||||||
:return: string of the latest tag or a default value if no tags exist
|
:return: string of the latest tag or a default value if no tags exist
|
||||||
"""
|
"""
|
||||||
tags: List[str] = get_local_tags(Path(__file__).parent.parent)
|
tags: List[str] = get_local_tags(PROJECT_ROOT)
|
||||||
if tags:
|
if tags:
|
||||||
return tags[-1]
|
return tags[-1]
|
||||||
else:
|
else:
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ def git_pull_wrapper(target_dir: Path) -> None:
|
|||||||
Logger.print_status("Updating repository ...")
|
Logger.print_status("Updating repository ...")
|
||||||
try:
|
try:
|
||||||
git_cmd_pull(target_dir)
|
git_cmd_pull(target_dir)
|
||||||
except CalledProcessError:
|
except (CalledProcessError, GitException):
|
||||||
log = "An unexpected error occured during updating the repository."
|
log = "An unexpected error occured during updating the repository."
|
||||||
Logger.print_error(log)
|
Logger.print_error(log)
|
||||||
return
|
return
|
||||||
@@ -102,6 +102,9 @@ def get_current_branch(repo: Path) -> str | None:
|
|||||||
:param repo: Path to the local Git repository
|
:param repo: Path to the local Git repository
|
||||||
:return: Current branch or None if not determinable
|
:return: Current branch or None if not determinable
|
||||||
"""
|
"""
|
||||||
|
if not repo.exists() or not repo.joinpath(".git").exists():
|
||||||
|
return None
|
||||||
|
|
||||||
try:
|
try:
|
||||||
cmd = ["git", "branch", "--show-current"]
|
cmd = ["git", "branch", "--show-current"]
|
||||||
result: str = check_output(cmd, stderr=DEVNULL, cwd=repo).decode(
|
result: str = check_output(cmd, stderr=DEVNULL, cwd=repo).decode(
|
||||||
@@ -109,7 +112,7 @@ def get_current_branch(repo: Path) -> str | None:
|
|||||||
)
|
)
|
||||||
return result.strip() if result else None
|
return result.strip() if result else None
|
||||||
|
|
||||||
except CalledProcessError:
|
except (CalledProcessError, FileNotFoundError):
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
|
||||||
@@ -120,6 +123,8 @@ def get_local_tags(repo_path: Path, _filter: str | None = None) -> List[str]:
|
|||||||
:param _filter: Optional filter to filter the tags by
|
:param _filter: Optional filter to filter the tags by
|
||||||
:return: List of tags
|
:return: List of tags
|
||||||
"""
|
"""
|
||||||
|
if not repo_path.exists() or not repo_path.joinpath(".git").is_dir():
|
||||||
|
return []
|
||||||
|
|
||||||
def parse_version(version: str) -> tuple:
|
def parse_version(version: str) -> tuple:
|
||||||
# Remove 'v' prefix if present
|
# Remove 'v' prefix if present
|
||||||
@@ -337,6 +342,11 @@ def git_cmd_checkout(branch: str | None, target_dir: Path) -> None:
|
|||||||
if branch is None:
|
if branch is None:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
if not target_dir.exists() or not target_dir.joinpath(".git").exists():
|
||||||
|
log = f"'{target_dir}' is not a valid git repository."
|
||||||
|
Logger.print_error(log)
|
||||||
|
raise GitException(log)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
command = ["git", "checkout", f"{branch}"]
|
command = ["git", "checkout", f"{branch}"]
|
||||||
run(command, cwd=target_dir, check=True)
|
run(command, cwd=target_dir, check=True)
|
||||||
@@ -349,6 +359,11 @@ def git_cmd_checkout(branch: str | None, target_dir: Path) -> None:
|
|||||||
|
|
||||||
|
|
||||||
def git_cmd_pull(target_dir: Path) -> None:
|
def git_cmd_pull(target_dir: Path) -> None:
|
||||||
|
if not target_dir.exists() or not target_dir.joinpath(".git").exists():
|
||||||
|
log = f"'{target_dir}' is not a valid git repository."
|
||||||
|
Logger.print_error(log)
|
||||||
|
raise GitException(log)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
command = ["git", "pull"]
|
command = ["git", "pull"]
|
||||||
run(command, cwd=target_dir, check=True)
|
run(command, cwd=target_dir, check=True)
|
||||||
@@ -359,6 +374,11 @@ def git_cmd_pull(target_dir: Path) -> None:
|
|||||||
|
|
||||||
|
|
||||||
def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
|
def rollback_repository(repo_dir: Path, instance: Type[InstanceType]) -> None:
|
||||||
|
if not repo_dir.exists() or not repo_dir.joinpath(".git").exists():
|
||||||
|
log = f"'{repo_dir}' is not a valid git repository."
|
||||||
|
Logger.print_error(log)
|
||||||
|
raise GitException(log)
|
||||||
|
|
||||||
q1 = "How many commits do you want to roll back"
|
q1 = "How many commits do you want to roll back"
|
||||||
amount = get_number_input(q1, 1, allow_go_back=True)
|
amount = get_number_input(q1, 1, allow_go_back=True)
|
||||||
|
|
||||||
@@ -394,7 +414,7 @@ def get_repo_url(repo_dir: Path) -> str | None:
|
|||||||
:param repo_dir: Path to the git repository
|
:param repo_dir: Path to the git repository
|
||||||
:return: URL of the remote repository or None if not found
|
:return: URL of the remote repository or None if not found
|
||||||
"""
|
"""
|
||||||
if not repo_dir.exists():
|
if not repo_dir.exists() or not repo_dir.joinpath(".git").exists():
|
||||||
return None
|
return None
|
||||||
|
|
||||||
try:
|
try:
|
||||||
|
|||||||
@@ -0,0 +1,21 @@
|
|||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
|
||||||
|
PROJECT_ROOT = Path(__file__).resolve().parents[3]
|
||||||
|
if str(PROJECT_ROOT) not in sys.path:
|
||||||
|
sys.path.insert(0, str(PROJECT_ROOT))
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture(autouse=True)
|
||||||
|
def silence_logger(monkeypatch: pytest.MonkeyPatch) -> None:
|
||||||
|
for name in (
|
||||||
|
"print_info",
|
||||||
|
"print_ok",
|
||||||
|
"print_warn",
|
||||||
|
"print_error",
|
||||||
|
"print_status",
|
||||||
|
"print_dialog",
|
||||||
|
):
|
||||||
|
monkeypatch.setattr(f"core.logger.Logger.{name}", lambda *a, **k: None)
|
||||||
@@ -0,0 +1,206 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from datetime import datetime
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import List, Set
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from core.constants import GLOBAL_DEPS
|
||||||
|
from utils.common import (
|
||||||
|
check_install_dependencies,
|
||||||
|
convert_camelcase_to_kebabcase,
|
||||||
|
get_current_date,
|
||||||
|
get_install_status,
|
||||||
|
get_kiauh_version,
|
||||||
|
moonraker_exists,
|
||||||
|
trunc_string,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetKiauhVersion:
|
||||||
|
def test_uses_project_root(self, monkeypatch) -> None:
|
||||||
|
expected_root = Path(__file__).parent.parent.parent.parent
|
||||||
|
captured: List[Path] = []
|
||||||
|
|
||||||
|
def fake_get_local_tags(path: Path, _filter: str | None = None) -> List[str]:
|
||||||
|
captured.append(path)
|
||||||
|
return ["v6.3.0", "v6.3.1"]
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.common.get_local_tags", fake_get_local_tags)
|
||||||
|
result = get_kiauh_version()
|
||||||
|
|
||||||
|
assert captured == [expected_root]
|
||||||
|
assert result == "v6.3.1"
|
||||||
|
|
||||||
|
def test_fallback_when_no_tags(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.common.get_local_tags", lambda *_a, **_k: [])
|
||||||
|
assert get_kiauh_version() == "v?.?.?"
|
||||||
|
|
||||||
|
|
||||||
|
class TestConvertCamelcaseToKebabcase:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"name,expected",
|
||||||
|
[
|
||||||
|
("Klipper", "klipper"),
|
||||||
|
("Moonraker", "moonraker"),
|
||||||
|
("MoonrakerObico", "moonraker-obico"),
|
||||||
|
("HTTPResponse", "h-t-t-p-response"),
|
||||||
|
("already", "already"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_converts(self, name: str, expected: str) -> None:
|
||||||
|
assert convert_camelcase_to_kebabcase(name) == expected
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetCurrentDate:
|
||||||
|
def test_returns_formatted_values(self) -> None:
|
||||||
|
result = get_current_date()
|
||||||
|
now = datetime.today()
|
||||||
|
|
||||||
|
assert set(result.keys()) == {"date", "time"}
|
||||||
|
assert result["date"] == now.strftime("%Y%m%d")
|
||||||
|
assert result["time"] == now.strftime("%H%M%S")
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckInstallDependencies:
|
||||||
|
def test_with_global_and_custom(self, monkeypatch) -> None:
|
||||||
|
checked: Set[str] = set()
|
||||||
|
updated: List[bool] = []
|
||||||
|
installed_pkgs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_check_package_install(deps: Set[str]) -> List[str]:
|
||||||
|
checked.update(deps)
|
||||||
|
return ["extra-pkg"]
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.check_package_install", fake_check_package_install
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.update_system_package_lists",
|
||||||
|
lambda silent: updated.append(silent),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.install_system_packages",
|
||||||
|
lambda pkgs: installed_pkgs.append(pkgs),
|
||||||
|
)
|
||||||
|
|
||||||
|
check_install_dependencies({"custom-pkg"}, include_global=True)
|
||||||
|
|
||||||
|
assert "custom-pkg" in checked
|
||||||
|
assert all(dep in checked for dep in GLOBAL_DEPS)
|
||||||
|
assert updated == [False]
|
||||||
|
assert installed_pkgs == [["extra-pkg"]]
|
||||||
|
|
||||||
|
def test_no_requirements(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.common.check_package_install", lambda *_a, **_k: [])
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.update_system_package_lists",
|
||||||
|
lambda *a, **k: pytest.fail("should not update when nothing to install"),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.install_system_packages",
|
||||||
|
lambda *a, **k: pytest.fail("should not install when nothing to install"),
|
||||||
|
)
|
||||||
|
|
||||||
|
check_install_dependencies({"pkg"})
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeInstanceType:
|
||||||
|
def __init__(self, suffix: str):
|
||||||
|
self.suffix = suffix
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
return isinstance(other, _FakeInstanceType) and self.suffix == other.suffix
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetInstallStatus:
|
||||||
|
def test_not_installed(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
env = tmp_path / "env"
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.common.get_current_branch", lambda *_a, **_k: None)
|
||||||
|
monkeypatch.setattr("utils.common.get_repo_name", lambda *_a, **_k: (None, None))
|
||||||
|
monkeypatch.setattr("utils.common.get_repo_url", lambda *_a, **_k: None)
|
||||||
|
monkeypatch.setattr("utils.common.get_local_commit", lambda *_a, **_k: None)
|
||||||
|
monkeypatch.setattr("utils.common.get_remote_commit", lambda *_a, **_k: None)
|
||||||
|
monkeypatch.setattr("utils.instance_utils.get_instances", lambda *_a, **_k: [])
|
||||||
|
|
||||||
|
status = get_install_status(repo, env, _FakeInstanceType)
|
||||||
|
|
||||||
|
assert status.status == 0
|
||||||
|
assert status.instances == 0
|
||||||
|
|
||||||
|
def test_fully_installed(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
env = tmp_path / "env"
|
||||||
|
repo.mkdir()
|
||||||
|
env.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
extra_file = tmp_path / "extra"
|
||||||
|
extra_file.write_text("x")
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.instance_utils.get_instances", lambda *_a, **_k: [_FakeInstanceType("")]
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.common.get_current_branch", lambda *_a, **_k: "main")
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.get_repo_name", lambda *_a, **_k: ("dw-0", "kiauh")
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.common.get_repo_url", lambda *_a, **_k: "https://github.com/dw-0/kiauh"
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.common.get_local_commit", lambda *_a, **_k: "abc")
|
||||||
|
monkeypatch.setattr("utils.common.get_remote_commit", lambda *_a, **_k: "def")
|
||||||
|
|
||||||
|
status = get_install_status(repo, env, _FakeInstanceType, files=[extra_file])
|
||||||
|
|
||||||
|
assert status.status == 2
|
||||||
|
assert status.instances == 1
|
||||||
|
assert status.owner == "dw-0"
|
||||||
|
assert status.repo == "kiauh"
|
||||||
|
assert status.branch == "main"
|
||||||
|
assert status.local == "abc"
|
||||||
|
assert status.remote == "def"
|
||||||
|
|
||||||
|
def test_incomplete(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
env = tmp_path / "env"
|
||||||
|
repo.mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.instance_utils.get_instances", lambda *_a, **_k: [_FakeInstanceType("")]
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.common.get_current_branch", lambda *_a, **_k: "main")
|
||||||
|
monkeypatch.setattr("utils.common.get_repo_name", lambda *_a, **_k: (None, None))
|
||||||
|
monkeypatch.setattr("utils.common.get_repo_url", lambda *_a, **_k: None)
|
||||||
|
monkeypatch.setattr("utils.common.get_local_commit", lambda *_a, **_k: None)
|
||||||
|
monkeypatch.setattr("utils.common.get_remote_commit", lambda *_a, **_k: None)
|
||||||
|
|
||||||
|
status = get_install_status(repo, env, _FakeInstanceType)
|
||||||
|
|
||||||
|
assert status.status == 1
|
||||||
|
|
||||||
|
|
||||||
|
class TestMoonrakerExists:
|
||||||
|
def test_returns_instances(self, monkeypatch) -> None:
|
||||||
|
fake = object()
|
||||||
|
monkeypatch.setattr("utils.common.get_instances", lambda *_a, **_k: [fake])
|
||||||
|
assert moonraker_exists() == [fake]
|
||||||
|
|
||||||
|
def test_warns_when_none(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.common.get_instances", lambda *_a, **_k: [])
|
||||||
|
assert moonraker_exists("SomeInstaller") == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestTruncString:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"value,length,expected",
|
||||||
|
[
|
||||||
|
("short", 10, "short"),
|
||||||
|
("exactly seven", 20, "exactly seven"),
|
||||||
|
("much longer string", 10, "much lo..."),
|
||||||
|
("abcdef", 5, "ab..."),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_truncates(self, value: str, length: int, expected: str) -> None:
|
||||||
|
assert trunc_string(value, length) == expected
|
||||||
@@ -0,0 +1,103 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from utils.config_utils import (
|
||||||
|
add_config_section,
|
||||||
|
add_config_section_at_top,
|
||||||
|
remove_config_section,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeInstance:
|
||||||
|
def __init__(self, cfg_file: Path):
|
||||||
|
self.cfg_file = cfg_file
|
||||||
|
|
||||||
|
|
||||||
|
def _write_cfg(path: Path, content: str) -> None:
|
||||||
|
path.write_text(content, encoding="utf-8")
|
||||||
|
|
||||||
|
|
||||||
|
class TestAddConfigSection:
|
||||||
|
def test_creates_section_and_options(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "printer.cfg"
|
||||||
|
_write_cfg(cfg, "[existing]\noption: value\n")
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
add_config_section(
|
||||||
|
"new_section",
|
||||||
|
[instance],
|
||||||
|
options=[("opt1", "val1"), ("opt2", ["line1", "line2"])],
|
||||||
|
)
|
||||||
|
|
||||||
|
text = cfg.read_text(encoding="utf-8")
|
||||||
|
assert "[new_section]" in text
|
||||||
|
assert "opt1: val1" in text
|
||||||
|
assert " line1" in text
|
||||||
|
assert " line2" in text
|
||||||
|
|
||||||
|
def test_skips_existing_section(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "printer.cfg"
|
||||||
|
_write_cfg(cfg, "[section]\noption: value\n")
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
add_config_section("section", [instance])
|
||||||
|
|
||||||
|
text = cfg.read_text(encoding="utf-8")
|
||||||
|
assert text.count("[section]") == 1
|
||||||
|
|
||||||
|
def test_warns_when_file_missing(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "missing.cfg"
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
add_config_section("section", [instance])
|
||||||
|
|
||||||
|
assert not cfg.exists()
|
||||||
|
|
||||||
|
|
||||||
|
class TestAddConfigSectionAtTop:
|
||||||
|
def test_prepends_section(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "printer.cfg"
|
||||||
|
original = "[old]\noption: value\n"
|
||||||
|
_write_cfg(cfg, original)
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
add_config_section_at_top("top_section", [instance])
|
||||||
|
|
||||||
|
text = cfg.read_text(encoding="utf-8")
|
||||||
|
lines = text.splitlines()
|
||||||
|
assert lines[0] == "[top_section]"
|
||||||
|
assert "[old]" in text
|
||||||
|
assert text.endswith("\n")
|
||||||
|
|
||||||
|
|
||||||
|
class TestRemoveConfigSection:
|
||||||
|
def test_removes_existing(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "printer.cfg"
|
||||||
|
_write_cfg(cfg, "[keep]\noption: 1\n[drop]\noption: 2\n")
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
removed = remove_config_section("drop", [instance])
|
||||||
|
|
||||||
|
assert removed == [instance]
|
||||||
|
text = cfg.read_text(encoding="utf-8")
|
||||||
|
assert "[drop]" not in text
|
||||||
|
assert "[keep]" in text
|
||||||
|
|
||||||
|
def test_skips_missing_section(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "printer.cfg"
|
||||||
|
_write_cfg(cfg, "[keep]\noption: 1\n")
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
removed = remove_config_section("missing", [instance])
|
||||||
|
|
||||||
|
assert removed == []
|
||||||
|
assert cfg.read_text(encoding="utf-8") == "[keep]\noption: 1\n"
|
||||||
|
|
||||||
|
def test_warns_when_file_missing(self, tmp_path: Path) -> None:
|
||||||
|
cfg = tmp_path / "missing.cfg"
|
||||||
|
instance = _FakeInstance(cfg)
|
||||||
|
|
||||||
|
removed = remove_config_section("section", [instance])
|
||||||
|
|
||||||
|
assert removed == []
|
||||||
@@ -0,0 +1,245 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from subprocess import CalledProcessError
|
||||||
|
from typing import Any, List
|
||||||
|
from zipfile import ZipFile
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from utils.fs_utils import (
|
||||||
|
check_file_exist,
|
||||||
|
create_folders,
|
||||||
|
create_symlink,
|
||||||
|
get_data_dir,
|
||||||
|
remove_file,
|
||||||
|
remove_with_sudo,
|
||||||
|
run_remove_routines,
|
||||||
|
unzip,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckFileExist:
|
||||||
|
def test_returns_true_for_existing_file(self, tmp_path: Path) -> None:
|
||||||
|
file = tmp_path / "file.txt"
|
||||||
|
file.write_text("x")
|
||||||
|
assert check_file_exist(file) is True
|
||||||
|
|
||||||
|
def test_returns_false_for_missing_file(self, tmp_path: Path) -> None:
|
||||||
|
assert check_file_exist(tmp_path / "missing") is False
|
||||||
|
|
||||||
|
def test_returns_false_for_broken_symlink(self, tmp_path: Path) -> None:
|
||||||
|
link = tmp_path / "link"
|
||||||
|
link.symlink_to(tmp_path / "target")
|
||||||
|
assert check_file_exist(link) is False
|
||||||
|
|
||||||
|
def test_with_sudo_uses_subprocess(self, monkeypatch) -> None:
|
||||||
|
calls: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_check_output(cmd: List[str], **kwargs: Any) -> bytes:
|
||||||
|
calls.append(cmd)
|
||||||
|
return b""
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.check_output", fake_check_output)
|
||||||
|
path = Path("/some/path")
|
||||||
|
assert check_file_exist(path, sudo=True) is True
|
||||||
|
assert calls[0] == ["sudo", "find", "-L", "/some/path", "-maxdepth", "0"]
|
||||||
|
|
||||||
|
def test_with_sudo_returns_false_on_error(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.fs_utils.check_output",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(CalledProcessError(1, "find")),
|
||||||
|
)
|
||||||
|
assert check_file_exist(Path("/some/path"), sudo=True) is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestCreateSymlink:
|
||||||
|
def test_calls_ln_with_correct_args(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.run", fake_run)
|
||||||
|
create_symlink(Path("/src"), Path("/dst"))
|
||||||
|
assert runs == [["ln", "-sf", "/src", "/dst"]]
|
||||||
|
|
||||||
|
def test_uses_sudo(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.run", fake_run)
|
||||||
|
create_symlink(Path("/src"), Path("/dst"), sudo=True)
|
||||||
|
assert runs == [["sudo", "ln", "-sf", "/src", "/dst"]]
|
||||||
|
|
||||||
|
def test_raises_on_failure(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.fs_utils.run",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(CalledProcessError(1, "ln")),
|
||||||
|
)
|
||||||
|
with pytest.raises(CalledProcessError):
|
||||||
|
create_symlink(Path("/src"), Path("/dst"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestRemoveWithSudo:
|
||||||
|
def test_removes_existing_files(self, monkeypatch) -> None:
|
||||||
|
calls: List[tuple] = []
|
||||||
|
|
||||||
|
def fake_call(cmd: List[str], **kwargs: Any) -> int:
|
||||||
|
calls.append(("call", cmd))
|
||||||
|
return 0
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
calls.append(("run", cmd))
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.call", fake_call)
|
||||||
|
monkeypatch.setattr("utils.fs_utils.run", fake_run)
|
||||||
|
|
||||||
|
result = remove_with_sudo(Path("/some/file"))
|
||||||
|
|
||||||
|
assert result is True
|
||||||
|
assert ("call", ["sudo", "find", "/some/file"]) in calls
|
||||||
|
assert ("run", ["sudo", "rm", "-rf", "/some/file"]) in calls
|
||||||
|
|
||||||
|
def test_skips_missing_files(self, monkeypatch) -> None:
|
||||||
|
def fake_call(cmd: List[str], **kwargs: Any) -> int:
|
||||||
|
return 1
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.call", fake_call)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.fs_utils.run",
|
||||||
|
lambda *a, **k: pytest.fail("should not run rm for missing file"),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert remove_with_sudo(Path("/some/file")) is False
|
||||||
|
|
||||||
|
def test_accepts_list(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_call(cmd: List[str], **kwargs: Any) -> int:
|
||||||
|
return 0
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.call", fake_call)
|
||||||
|
monkeypatch.setattr("utils.fs_utils.run", fake_run)
|
||||||
|
|
||||||
|
remove_with_sudo([Path("/a"), Path("/b")])
|
||||||
|
|
||||||
|
assert runs == [
|
||||||
|
["sudo", "rm", "-rf", "/a"],
|
||||||
|
["sudo", "rm", "-rf", "/b"],
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
class TestRemoveFile:
|
||||||
|
def test_calls_shell_rm(self, monkeypatch) -> None:
|
||||||
|
runs: List[Any] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: str, **kwargs: Any) -> Any:
|
||||||
|
runs.append((cmd, kwargs.get("shell")))
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.fs_utils.run", fake_run)
|
||||||
|
|
||||||
|
with pytest.warns(DeprecationWarning):
|
||||||
|
remove_file(Path("/some/file"), sudo=True)
|
||||||
|
|
||||||
|
assert runs == [("sudo rm -f /some/file", True)]
|
||||||
|
|
||||||
|
|
||||||
|
class TestRunRemoveRoutines:
|
||||||
|
def test_returns_false_for_missing(self, tmp_path: Path) -> None:
|
||||||
|
assert run_remove_routines(tmp_path / "missing") is False
|
||||||
|
|
||||||
|
def test_removes_file(self, tmp_path: Path) -> None:
|
||||||
|
file = tmp_path / "file.txt"
|
||||||
|
file.write_text("x")
|
||||||
|
assert run_remove_routines(file) is True
|
||||||
|
assert not file.exists()
|
||||||
|
|
||||||
|
def test_removes_directory(self, tmp_path: Path) -> None:
|
||||||
|
directory = tmp_path / "dir"
|
||||||
|
directory.mkdir()
|
||||||
|
(directory / "child").write_text("x")
|
||||||
|
assert run_remove_routines(directory) is True
|
||||||
|
assert not directory.exists()
|
||||||
|
|
||||||
|
def test_removes_symlink(self, tmp_path: Path) -> None:
|
||||||
|
target = tmp_path / "target"
|
||||||
|
target.write_text("x")
|
||||||
|
link = tmp_path / "link"
|
||||||
|
link.symlink_to(target)
|
||||||
|
assert run_remove_routines(link) is True
|
||||||
|
assert not link.exists()
|
||||||
|
assert target.exists()
|
||||||
|
|
||||||
|
|
||||||
|
class TestUnzip:
|
||||||
|
def test_extracts_contents(self, tmp_path: Path) -> None:
|
||||||
|
archive = tmp_path / "archive.zip"
|
||||||
|
target = tmp_path / "out"
|
||||||
|
target.mkdir()
|
||||||
|
|
||||||
|
with ZipFile(archive, "w") as zf:
|
||||||
|
zf.writestr("hello.txt", "world")
|
||||||
|
|
||||||
|
unzip(archive, target)
|
||||||
|
|
||||||
|
assert (target / "hello.txt").read_text() == "world"
|
||||||
|
|
||||||
|
|
||||||
|
class TestCreateFolders:
|
||||||
|
def test_creates_missing_directories(self, tmp_path: Path) -> None:
|
||||||
|
dirs = [tmp_path / "a", tmp_path / "b"]
|
||||||
|
create_folders(dirs)
|
||||||
|
assert all(d.exists() for d in dirs)
|
||||||
|
|
||||||
|
def test_skips_existing(self, tmp_path: Path) -> None:
|
||||||
|
existing = tmp_path / "exists"
|
||||||
|
existing.mkdir()
|
||||||
|
create_folders([existing])
|
||||||
|
assert existing.exists()
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetDataDir:
|
||||||
|
def test_reads_from_service_file(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
service = tmp_path / "klipper.service"
|
||||||
|
service.write_text(
|
||||||
|
"EnvironmentFile=/home/user/printer_data/systemd/klipper.env\n"
|
||||||
|
)
|
||||||
|
|
||||||
|
def fake_service_path(instance_type: type, suffix: str) -> Path:
|
||||||
|
return service
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.get_service_file_path", fake_service_path)
|
||||||
|
monkeypatch.setattr("utils.fs_utils.Path.home", lambda: tmp_path / "home")
|
||||||
|
|
||||||
|
result = get_data_dir(object, "")
|
||||||
|
assert result == Path("/home/user/printer_data")
|
||||||
|
|
||||||
|
def test_falls_back_to_suffixed_data_dir(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
def fake_service_path(instance_type: type, suffix: str) -> Path:
|
||||||
|
return tmp_path / "no-such.service"
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.get_service_file_path", fake_service_path)
|
||||||
|
home = tmp_path / "home"
|
||||||
|
monkeypatch.setattr("utils.fs_utils.Path.home", lambda: home)
|
||||||
|
|
||||||
|
assert get_data_dir(object, "1") == home / "printer_1_data"
|
||||||
|
|
||||||
|
def test_falls_back_to_default_data_dir(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
def fake_service_path(instance_type: type, suffix: str) -> Path:
|
||||||
|
return tmp_path / "no-such.service"
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.get_service_file_path", fake_service_path)
|
||||||
|
home = tmp_path / "home"
|
||||||
|
monkeypatch.setattr("utils.fs_utils.Path.home", lambda: home)
|
||||||
|
|
||||||
|
assert get_data_dir(object, "") == home / "printer_data"
|
||||||
@@ -0,0 +1,535 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from subprocess import CalledProcessError
|
||||||
|
from typing import Any, List
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from utils.git_utils import (
|
||||||
|
GitException,
|
||||||
|
compare_semver_tags,
|
||||||
|
get_current_branch,
|
||||||
|
get_latest_remote_tag,
|
||||||
|
get_latest_unstable_tag,
|
||||||
|
get_local_commit,
|
||||||
|
get_local_tags,
|
||||||
|
get_remote_commit,
|
||||||
|
get_remote_tags,
|
||||||
|
get_repo_name,
|
||||||
|
get_repo_url,
|
||||||
|
git_clone_wrapper,
|
||||||
|
git_cmd_checkout,
|
||||||
|
git_cmd_clone,
|
||||||
|
git_cmd_pull,
|
||||||
|
git_pull_wrapper,
|
||||||
|
rollback_repository,
|
||||||
|
)
|
||||||
|
from utils.instance_type import InstanceType
|
||||||
|
|
||||||
|
|
||||||
|
class TestGitCmdPull:
|
||||||
|
def test_missing_dir_raises(self, tmp_path: Path) -> None:
|
||||||
|
missing = tmp_path / "does-not-exist"
|
||||||
|
with pytest.raises(GitException):
|
||||||
|
git_cmd_pull(missing)
|
||||||
|
|
||||||
|
def test_dir_without_git_raises(self, tmp_path: Path) -> None:
|
||||||
|
empty = tmp_path / "no-git"
|
||||||
|
empty.mkdir()
|
||||||
|
with pytest.raises(GitException):
|
||||||
|
git_cmd_pull(empty)
|
||||||
|
|
||||||
|
def test_success_runs_git_pull(self, monkeypatch) -> None:
|
||||||
|
repo = Path("/fake/repo")
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.Path.exists", lambda self: True)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.Path.joinpath", lambda self, name: repo / name
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.git_utils.run", fake_run)
|
||||||
|
|
||||||
|
git_cmd_pull(repo)
|
||||||
|
assert runs == [["git", "pull"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGitCmdCheckout:
|
||||||
|
def test_missing_dir_raises(self, tmp_path: Path) -> None:
|
||||||
|
missing = tmp_path / "does-not-exist"
|
||||||
|
with pytest.raises(GitException):
|
||||||
|
git_cmd_checkout("main", missing)
|
||||||
|
|
||||||
|
def test_dir_without_git_raises(self, tmp_path: Path) -> None:
|
||||||
|
empty = tmp_path / "no-git"
|
||||||
|
empty.mkdir()
|
||||||
|
with pytest.raises(GitException):
|
||||||
|
git_cmd_checkout("main", empty)
|
||||||
|
|
||||||
|
def test_none_branch_returns(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.run",
|
||||||
|
lambda *a, **k: pytest.fail("should not run checkout for None branch"),
|
||||||
|
)
|
||||||
|
git_cmd_checkout(None, Path("/repo"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestGitPullWrapper:
|
||||||
|
def test_missing_dir_does_not_raise(self, tmp_path: Path) -> None:
|
||||||
|
missing = tmp_path / "does-not-exist"
|
||||||
|
git_pull_wrapper(missing)
|
||||||
|
|
||||||
|
def test_dir_without_git_does_not_raise(self, tmp_path: Path) -> None:
|
||||||
|
empty = tmp_path / "no-git"
|
||||||
|
empty.mkdir()
|
||||||
|
git_pull_wrapper(empty)
|
||||||
|
|
||||||
|
def test_success_calls_git_pull(self, monkeypatch) -> None:
|
||||||
|
repo = Path("/fake/repo")
|
||||||
|
called: List[Path] = []
|
||||||
|
|
||||||
|
def fake_git_cmd_pull(path: Path) -> None:
|
||||||
|
called.append(path)
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_pull", fake_git_cmd_pull)
|
||||||
|
git_pull_wrapper(repo)
|
||||||
|
assert called == [repo]
|
||||||
|
|
||||||
|
|
||||||
|
class TestRollbackRepository:
|
||||||
|
def test_missing_dir_raises(
|
||||||
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
missing = tmp_path / "does-not-exist"
|
||||||
|
called: list[bool] = []
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_number_input",
|
||||||
|
lambda *_a, **_k: called.append(True) or 1,
|
||||||
|
)
|
||||||
|
with pytest.raises(GitException):
|
||||||
|
rollback_repository(missing, InstanceType)
|
||||||
|
assert not called
|
||||||
|
|
||||||
|
def test_dir_without_git_raises(
|
||||||
|
self, tmp_path: Path, monkeypatch: pytest.MonkeyPatch
|
||||||
|
) -> None:
|
||||||
|
empty = tmp_path / "no-git"
|
||||||
|
empty.mkdir()
|
||||||
|
called: list[bool] = []
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_number_input",
|
||||||
|
lambda *_a, **_k: called.append(True) or 1,
|
||||||
|
)
|
||||||
|
with pytest.raises(GitException):
|
||||||
|
rollback_repository(empty, InstanceType)
|
||||||
|
assert not called
|
||||||
|
|
||||||
|
def test_aborts_when_not_confirmed(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_number_input", lambda *a, **k: 2)
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_confirm", lambda *a, **k: False)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_instances", lambda *a, **k: ["instance"]
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.InstanceManager.stop_all",
|
||||||
|
lambda *a, **k: pytest.fail("should not stop when aborted"),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.run",
|
||||||
|
lambda *a, **k: pytest.fail("should not reset when aborted"),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.InstanceManager.start_all",
|
||||||
|
lambda *a, **k: pytest.fail("should not start when aborted"),
|
||||||
|
)
|
||||||
|
|
||||||
|
rollback_repository(repo, InstanceType)
|
||||||
|
|
||||||
|
def test_resets_and_restarts_when_confirmed(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
stops: List[List[Any]] = []
|
||||||
|
starts: List[List[Any]] = []
|
||||||
|
resets: List[List[str]] = []
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_number_input", lambda *a, **k: 3)
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_confirm", lambda *a, **k: True)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_instances", lambda *a, **k: ["instance"]
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.InstanceManager.stop_all",
|
||||||
|
lambda instances: stops.append(instances),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.InstanceManager.start_all",
|
||||||
|
lambda instances: starts.append(instances),
|
||||||
|
)
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
resets.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.run", fake_run)
|
||||||
|
|
||||||
|
rollback_repository(repo, InstanceType)
|
||||||
|
|
||||||
|
assert stops == [["instance"]]
|
||||||
|
assert resets == [["git", "reset", "--hard", "HEAD~3"]]
|
||||||
|
assert starts == [["instance"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetRepoName:
|
||||||
|
def test_extracts_org_and_repo(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.check_output",
|
||||||
|
lambda *a, **k: b"https://github.com/dw-0/kiauh.git\n",
|
||||||
|
)
|
||||||
|
assert get_repo_name(repo) == ("dw-0", "kiauh")
|
||||||
|
|
||||||
|
def test_returns_none_for_missing_repo(self, tmp_path: Path) -> None:
|
||||||
|
assert get_repo_name(tmp_path / "missing") == (None, None)
|
||||||
|
|
||||||
|
def test_returns_none_on_git_error(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.check_output",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(CalledProcessError(1, "git")),
|
||||||
|
)
|
||||||
|
assert get_repo_name(repo) == (None, None)
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetCurrentBranch:
|
||||||
|
def test_returns_branch(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.check_output", lambda *a, **k: b"feature-x\n"
|
||||||
|
)
|
||||||
|
assert get_current_branch(repo) == "feature-x"
|
||||||
|
|
||||||
|
def test_returns_none_for_missing_repo(self, tmp_path: Path) -> None:
|
||||||
|
assert get_current_branch(tmp_path / "missing") is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetLocalTags:
|
||||||
|
def test_sorts_semver(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.check_output",
|
||||||
|
lambda *a, **k: b"v1.0.0\nv1.0.1\nv1.0.10\nv1.0.2\nv2.0.0-beta.1\n",
|
||||||
|
)
|
||||||
|
assert get_local_tags(repo) == [
|
||||||
|
"v1.0.0",
|
||||||
|
"v1.0.1",
|
||||||
|
"v1.0.2",
|
||||||
|
"v1.0.10",
|
||||||
|
"v2.0.0-beta.1",
|
||||||
|
]
|
||||||
|
|
||||||
|
def test_returns_empty_for_missing_repo(self, tmp_path: Path) -> None:
|
||||||
|
assert get_local_tags(tmp_path / "missing") == []
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeResponse:
|
||||||
|
def __init__(self, code: int, body: bytes = b""):
|
||||||
|
self._code = code
|
||||||
|
self._body = body
|
||||||
|
|
||||||
|
def __enter__(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def __exit__(self, *args):
|
||||||
|
return None
|
||||||
|
|
||||||
|
def getcode(self) -> int:
|
||||||
|
return self._code
|
||||||
|
|
||||||
|
def read(self) -> bytes:
|
||||||
|
return self._body
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetRemoteTags:
|
||||||
|
def test_parses_github_api(self, monkeypatch) -> None:
|
||||||
|
body = b'[{"name":"v1.0.0"},{"name":"v1.1.0"}]'
|
||||||
|
|
||||||
|
class FakeUrlLib:
|
||||||
|
@staticmethod
|
||||||
|
def urlopen(url: str):
|
||||||
|
return _FakeResponse(200, body)
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.urllib.request", FakeUrlLib())
|
||||||
|
assert get_remote_tags("dw-0/kiauh") == ["v1.0.0", "v1.1.0"]
|
||||||
|
|
||||||
|
def test_returns_empty_on_http_error(self, monkeypatch) -> None:
|
||||||
|
class FakeUrlLib:
|
||||||
|
@staticmethod
|
||||||
|
def urlopen(url: str):
|
||||||
|
return _FakeResponse(404)
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.urllib.request", FakeUrlLib())
|
||||||
|
assert get_remote_tags("dw-0/kiauh") == []
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetLatestRemoteTag:
|
||||||
|
def test_returns_first_tag(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_remote_tags", lambda *_a, **_k: ["v2.0.0", "v1.0.0"]
|
||||||
|
)
|
||||||
|
assert get_latest_remote_tag("dw-0/kiauh") == "v2.0.0"
|
||||||
|
|
||||||
|
def test_returns_empty_when_no_tags(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_remote_tags", lambda *_a, **_k: [])
|
||||||
|
assert get_latest_remote_tag("dw-0/kiauh") == ""
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetLatestUnstableTag:
|
||||||
|
def test_filters_prereleases(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_remote_tags",
|
||||||
|
lambda *_a, **_k: ["v2.0.0", "v2.0.0-rc.1", "v1.0.0-beta.2"],
|
||||||
|
)
|
||||||
|
assert get_latest_unstable_tag("dw-0/kiauh") == "v2.0.0-rc.1"
|
||||||
|
|
||||||
|
def test_returns_empty_when_stable_only(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_remote_tags", lambda *_a, **_k: ["v2.0.0", "v1.0.0"]
|
||||||
|
)
|
||||||
|
assert get_latest_unstable_tag("dw-0/kiauh") == ""
|
||||||
|
|
||||||
|
|
||||||
|
class TestCompareSemverTags:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"tag1,tag2,expected",
|
||||||
|
[
|
||||||
|
("v1.0.0", "v1.0.1", False),
|
||||||
|
("v1.1.0", "v1.0.1", True),
|
||||||
|
("v1.0.0", "v1.0.0", False),
|
||||||
|
("v2.0.0", "v1.9.9", True),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_comparison(self, tag1: str, tag2: str, expected: bool) -> None:
|
||||||
|
assert compare_semver_tags(tag1, tag2) is expected
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetLocalCommit:
|
||||||
|
def test_describes_head(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.check_output",
|
||||||
|
lambda *a, **k: "v1.0.0-0-gabc1234",
|
||||||
|
)
|
||||||
|
assert get_local_commit(repo) == "v1.0.0-0-gabc1234"
|
||||||
|
|
||||||
|
def test_returns_none_for_missing_repo(self, tmp_path: Path) -> None:
|
||||||
|
assert get_local_commit(tmp_path / "missing") is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetRemoteCommit:
|
||||||
|
def test_describes_origin(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
def fake_check_output(cmd: str, **kwargs: Any) -> str:
|
||||||
|
if "HEAD" in cmd:
|
||||||
|
return "v1.0.0"
|
||||||
|
return "origin/main"
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_current_branch", lambda *_a, **_k: "main"
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.git_utils.check_output", fake_check_output)
|
||||||
|
assert get_remote_commit(repo) == "origin/main"
|
||||||
|
|
||||||
|
def test_returns_none_for_missing_repo(self, tmp_path: Path) -> None:
|
||||||
|
assert get_remote_commit(tmp_path / "missing") is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestGitCmdClone:
|
||||||
|
def test_without_blobless(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.run", fake_run)
|
||||||
|
git_cmd_clone("https://github.com/dw-0/kiauh", Path("/target"))
|
||||||
|
assert runs == [["git", "clone", "https://github.com/dw-0/kiauh", "/target"]]
|
||||||
|
|
||||||
|
def test_with_blobless(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.run", fake_run)
|
||||||
|
git_cmd_clone(
|
||||||
|
"https://github.com/dw-0/kiauh", Path("/target"), blobless=True
|
||||||
|
)
|
||||||
|
assert runs == [
|
||||||
|
[
|
||||||
|
"git",
|
||||||
|
"clone",
|
||||||
|
"--filter=blob:none",
|
||||||
|
"https://github.com/dw-0/kiauh",
|
||||||
|
"/target",
|
||||||
|
]
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGitCmdCheckoutSingle:
|
||||||
|
def test_runs_git_checkout(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.run", fake_run)
|
||||||
|
git_cmd_checkout("dev", repo)
|
||||||
|
assert runs == [["git", "checkout", "dev"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetRepoUrl:
|
||||||
|
def test_extracts_remote_url(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
class FakeResult:
|
||||||
|
stdout = "https://github.com/dw-0/kiauh.git\n"
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.run", lambda *a, **k: FakeResult())
|
||||||
|
assert get_repo_url(repo) == "https://github.com/dw-0/kiauh.git"
|
||||||
|
|
||||||
|
def test_returns_none_for_missing_repo(self, tmp_path: Path) -> None:
|
||||||
|
assert get_repo_url(tmp_path / "missing") is None
|
||||||
|
|
||||||
|
def test_returns_none_on_git_error(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
repo = tmp_path / "repo"
|
||||||
|
repo.mkdir()
|
||||||
|
(repo / ".git").mkdir()
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.run",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(CalledProcessError(1, "git")),
|
||||||
|
)
|
||||||
|
assert get_repo_url(repo) is None
|
||||||
|
|
||||||
|
|
||||||
|
class _CloneRecorder:
|
||||||
|
def __init__(self):
|
||||||
|
self.calls: List[tuple] = []
|
||||||
|
self.checkouts: List[tuple] = []
|
||||||
|
self.removed: List[Path] = []
|
||||||
|
|
||||||
|
def fake_clone(self, repo: str, target: Path, blobless: bool = False) -> None:
|
||||||
|
self.calls.append((repo, target, blobless))
|
||||||
|
|
||||||
|
def fake_checkout(self, branch: str | None, target: Path) -> None:
|
||||||
|
self.checkouts.append((branch, target))
|
||||||
|
|
||||||
|
|
||||||
|
class TestGitCloneWrapper:
|
||||||
|
def test_clones_when_target_missing(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
target = tmp_path / "kiauh"
|
||||||
|
recorder = _CloneRecorder()
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_clone", recorder.fake_clone)
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_checkout", recorder.fake_checkout)
|
||||||
|
|
||||||
|
git_clone_wrapper("https://github.com/dw-0/kiauh", target, branch="dev")
|
||||||
|
|
||||||
|
assert recorder.calls == [("https://github.com/dw-0/kiauh", target, True)]
|
||||||
|
assert recorder.checkouts == [("dev", target)]
|
||||||
|
|
||||||
|
def test_skips_checkout_for_main(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
target = tmp_path / "kiauh"
|
||||||
|
recorder = _CloneRecorder()
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_clone", recorder.fake_clone)
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_checkout", recorder.fake_checkout)
|
||||||
|
|
||||||
|
git_clone_wrapper("https://github.com/dw-0/kiauh", target, branch="main")
|
||||||
|
|
||||||
|
assert recorder.checkouts == []
|
||||||
|
|
||||||
|
def test_prompts_before_overwrite(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
target = tmp_path / "kiauh"
|
||||||
|
target.mkdir()
|
||||||
|
recorder = _CloneRecorder()
|
||||||
|
removed: List[Path] = []
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_clone", recorder.fake_clone)
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_checkout", recorder.fake_checkout)
|
||||||
|
monkeypatch.setattr("utils.git_utils.shutil.rmtree", lambda p: removed.append(p))
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_confirm", lambda *a, **k: True)
|
||||||
|
|
||||||
|
git_clone_wrapper("https://github.com/dw-0/kiauh", target, branch="dev")
|
||||||
|
|
||||||
|
assert removed == [target]
|
||||||
|
assert recorder.calls == [("https://github.com/dw-0/kiauh", target, True)]
|
||||||
|
|
||||||
|
def test_respects_decline_to_overwrite(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
target = tmp_path / "kiauh"
|
||||||
|
target.mkdir()
|
||||||
|
recorder = _CloneRecorder()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_clone", recorder.fake_clone)
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_checkout", recorder.fake_checkout)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.shutil.rmtree",
|
||||||
|
lambda *a, **k: pytest.fail("should not remove"),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.git_utils.get_confirm", lambda *a, **k: False)
|
||||||
|
|
||||||
|
git_clone_wrapper("https://github.com/dw-0/kiauh", target)
|
||||||
|
|
||||||
|
assert recorder.calls == []
|
||||||
|
|
||||||
|
def test_force_overwrites_without_prompt(self, monkeypatch, tmp_path: Path) -> None:
|
||||||
|
target = tmp_path / "kiauh"
|
||||||
|
target.mkdir()
|
||||||
|
recorder = _CloneRecorder()
|
||||||
|
removed: List[Path] = []
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_clone", recorder.fake_clone)
|
||||||
|
monkeypatch.setattr("utils.git_utils.git_cmd_checkout", recorder.fake_checkout)
|
||||||
|
monkeypatch.setattr("utils.git_utils.shutil.rmtree", lambda p: removed.append(p))
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.git_utils.get_confirm",
|
||||||
|
lambda *a, **k: pytest.fail("should not prompt when forced"),
|
||||||
|
)
|
||||||
|
|
||||||
|
git_clone_wrapper("https://github.com/dw-0/kiauh", target, force=True)
|
||||||
|
|
||||||
|
assert removed == [target]
|
||||||
|
assert recorder.calls == [("https://github.com/dw-0/kiauh", target, True)]
|
||||||
@@ -0,0 +1,158 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import Any, List
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from utils.input_utils import (
|
||||||
|
format_question,
|
||||||
|
get_confirm,
|
||||||
|
get_number_input,
|
||||||
|
get_selection_input,
|
||||||
|
get_string_input,
|
||||||
|
validate_number_input,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _input_sequence(answers: List[str]):
|
||||||
|
it = iter(answers)
|
||||||
|
|
||||||
|
def _input(_prompt: str = "") -> str:
|
||||||
|
return next(it)
|
||||||
|
|
||||||
|
return _input
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetConfirm:
|
||||||
|
def test_accepts_yes(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["y"]))
|
||||||
|
assert get_confirm("go?") is True
|
||||||
|
|
||||||
|
def test_accepts_no(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["n"]))
|
||||||
|
assert get_confirm("go?") is False
|
||||||
|
|
||||||
|
def test_default_yes_on_empty(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence([""]))
|
||||||
|
assert get_confirm("go?", default_choice=True) is True
|
||||||
|
|
||||||
|
def test_default_no_on_empty(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence([""]))
|
||||||
|
assert get_confirm("go?", default_choice=False) is False
|
||||||
|
|
||||||
|
def test_handles_invalid_then_valid(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["maybe", "yes"]))
|
||||||
|
assert get_confirm("go?") is True
|
||||||
|
|
||||||
|
def test_go_back_returns_none(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["b"]))
|
||||||
|
assert get_confirm("go?", allow_go_back=True) is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetNumberInput:
|
||||||
|
def test_returns_valid(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["5"]))
|
||||||
|
assert get_number_input("count?", 1, 10) == 5
|
||||||
|
|
||||||
|
def test_uses_default(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence([""]))
|
||||||
|
assert get_number_input("count?", 1, default=3) == 3
|
||||||
|
|
||||||
|
def test_enforces_minimum(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["0", "2"]))
|
||||||
|
assert get_number_input("count?", 1) == 2
|
||||||
|
|
||||||
|
def test_enforces_maximum(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["11", "9"]))
|
||||||
|
assert get_number_input("count?", 1, 10) == 9
|
||||||
|
|
||||||
|
def test_go_back_returns_none(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["b"]))
|
||||||
|
assert get_number_input("count?", 1, allow_go_back=True) is None
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetStringInput:
|
||||||
|
def test_accepts_alphanumeric(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["abc123"]))
|
||||||
|
assert get_string_input("name?") == "abc123"
|
||||||
|
|
||||||
|
def test_rejects_empty(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["", "value"]))
|
||||||
|
assert get_string_input("name?") == "value"
|
||||||
|
|
||||||
|
def test_uses_default(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence([""]))
|
||||||
|
assert get_string_input("name?", default="fallback") == "fallback"
|
||||||
|
|
||||||
|
def test_validates_regex(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["@", "#"]))
|
||||||
|
assert get_string_input("name?", regex=r"^#+$") == "#"
|
||||||
|
|
||||||
|
def test_rejects_excluded(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["taken", "free"]))
|
||||||
|
assert get_string_input("name?", exclude=["taken"]) == "free"
|
||||||
|
|
||||||
|
def test_allows_special_chars(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["a-b_c"]))
|
||||||
|
assert get_string_input("name?", allow_special_chars=True) == "a-b_c"
|
||||||
|
|
||||||
|
def test_allows_empty_with_special_chars(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence([""]))
|
||||||
|
assert (
|
||||||
|
get_string_input("name?", allow_empty=True, allow_special_chars=True) == ""
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetSelectionInput:
|
||||||
|
def test_from_list(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["b"]))
|
||||||
|
assert get_selection_input("pick?", ["a", "b", "c"]) == "b"
|
||||||
|
|
||||||
|
def test_from_dict(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["two"]))
|
||||||
|
assert get_selection_input("pick?", {"one": 1, "two": 2}) == "two"
|
||||||
|
|
||||||
|
def test_invalid_then_valid(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["z", "a"]))
|
||||||
|
assert get_selection_input("pick?", ["a", "b"]) == "a"
|
||||||
|
|
||||||
|
def test_invalid_type_raises(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("builtins.input", _input_sequence(["x"]))
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
get_selection_input("pick?", 123) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
|
||||||
|
class TestFormatQuestion:
|
||||||
|
def test_includes_default(self) -> None:
|
||||||
|
assert "default=5" in format_question("count", 5)
|
||||||
|
|
||||||
|
def test_no_default(self) -> None:
|
||||||
|
assert "count" in format_question("count")
|
||||||
|
assert "default" not in format_question("count")
|
||||||
|
|
||||||
|
|
||||||
|
class TestValidateNumberInput:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"value,min_count,max_count,expected",
|
||||||
|
[
|
||||||
|
("5", 1, 10, 5),
|
||||||
|
("1", 1, 10, 1),
|
||||||
|
("10", 1, 10, 10),
|
||||||
|
("3", 1, None, 3),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_valid(
|
||||||
|
self, value: str, min_count: int, max_count: Any, expected: int
|
||||||
|
) -> None:
|
||||||
|
assert validate_number_input(value, min_count, max_count) == expected
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"value,min_count,max_count",
|
||||||
|
[
|
||||||
|
("0", 1, 10),
|
||||||
|
("11", 1, 10),
|
||||||
|
("-1", 0, None),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_raises(self, value: str, min_count: int, max_count: Any) -> None:
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
validate_number_input(value, min_count, max_count)
|
||||||
@@ -0,0 +1,17 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from typing import TypeVar
|
||||||
|
|
||||||
|
from components.klipper.klipper import Klipper
|
||||||
|
from components.moonraker.moonraker import Moonraker
|
||||||
|
from utils.instance_type import InstanceType
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstanceType:
|
||||||
|
def test_is_typevar(self) -> None:
|
||||||
|
assert isinstance(InstanceType, TypeVar)
|
||||||
|
|
||||||
|
def test_bound_classes_include_components(self) -> None:
|
||||||
|
bound = InstanceType.__constraints__
|
||||||
|
assert Klipper in bound
|
||||||
|
assert Moonraker in bound
|
||||||
@@ -0,0 +1,98 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
from pathlib import Path
|
||||||
|
from typing import List
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from utils.instance_utils import (
|
||||||
|
get_instance_suffix,
|
||||||
|
get_instances,
|
||||||
|
stop_klipper_instances_interactively,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class Klipper:
|
||||||
|
def __init__(self, suffix: str):
|
||||||
|
self.suffix = suffix
|
||||||
|
|
||||||
|
def __eq__(self, other):
|
||||||
|
return isinstance(other, Klipper) and self.suffix == other.suffix
|
||||||
|
|
||||||
|
def __repr__(self):
|
||||||
|
return f"Klipper({self.suffix!r})"
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetInstances:
|
||||||
|
def test_returns_empty_when_no_services(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.instance_utils.SYSTEMD", tmp_path)
|
||||||
|
assert get_instances(Klipper) == []
|
||||||
|
|
||||||
|
def test_raises_when_not_a_class(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.instance_utils.SYSTEMD", tmp_path)
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
get_instances("not-a-class") # type: ignore[arg-type]
|
||||||
|
|
||||||
|
def test_finds_and_sorts_instances(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.instance_utils.SYSTEMD", tmp_path)
|
||||||
|
|
||||||
|
(tmp_path / "klipper.service").write_text("")
|
||||||
|
(tmp_path / "klipper-1.service").write_text("")
|
||||||
|
(tmp_path / "klipper-10.service").write_text("")
|
||||||
|
(tmp_path / "klipper-a.service").write_text("")
|
||||||
|
|
||||||
|
instances = get_instances(Klipper)
|
||||||
|
assert [i.suffix for i in instances] == ["", "1", "10", "a"]
|
||||||
|
|
||||||
|
def test_excludes_blacklisted_suffixes(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.instance_utils.SYSTEMD", tmp_path)
|
||||||
|
|
||||||
|
(tmp_path / "klipper.service").write_text("")
|
||||||
|
(tmp_path / "klipper-mcu.service").write_text("")
|
||||||
|
|
||||||
|
instances = get_instances(Klipper)
|
||||||
|
assert [i.suffix for i in instances] == [""]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetInstanceSuffix:
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"name,service,expected",
|
||||||
|
[
|
||||||
|
("klipper", "klipper.service", ""),
|
||||||
|
("klipper", "klipper-1.service", "1"),
|
||||||
|
("klipper", "klipper-10.service", "10"),
|
||||||
|
("moonraker", "moonraker-foo.service", "foo"),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_suffix(self, name: str, service: str, expected: str) -> None:
|
||||||
|
assert get_instance_suffix(name, Path(service)) == expected
|
||||||
|
|
||||||
|
|
||||||
|
class TestStopKlipperInstancesInteractively:
|
||||||
|
def test_empty_returns_true(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.instance_utils.get_confirm",
|
||||||
|
lambda *a, **k: pytest.fail("no prompt when no instances"),
|
||||||
|
)
|
||||||
|
assert stop_klipper_instances_interactively([]) is True
|
||||||
|
|
||||||
|
def test_stops_on_confirm(self, monkeypatch) -> None:
|
||||||
|
stopped: List[Klipper] = []
|
||||||
|
instance = Klipper("")
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.instance_utils.get_confirm", lambda *a, **k: True)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.instance_utils.InstanceManager.stop_all",
|
||||||
|
lambda instances: stopped.extend(instances),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert stop_klipper_instances_interactively([instance], "update") is True
|
||||||
|
assert [i.suffix for i in stopped] == [""]
|
||||||
|
|
||||||
|
def test_aborts_on_decline(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.instance_utils.get_confirm", lambda *a, **k: False)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.instance_utils.InstanceManager.stop_all",
|
||||||
|
lambda *a, **k: pytest.fail("should not stop when declined"),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert stop_klipper_instances_interactively([Klipper("")]) is False
|
||||||
@@ -0,0 +1,686 @@
|
|||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import builtins
|
||||||
|
from io import StringIO
|
||||||
|
from pathlib import Path
|
||||||
|
from subprocess import CalledProcessError
|
||||||
|
from typing import Any, List
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from utils.sys_utils import (
|
||||||
|
VenvCreationFailedException,
|
||||||
|
check_package_install,
|
||||||
|
check_python_version,
|
||||||
|
cmd_sysctl_manage,
|
||||||
|
cmd_sysctl_service,
|
||||||
|
create_env_file,
|
||||||
|
create_python_venv,
|
||||||
|
create_service_file,
|
||||||
|
download_file,
|
||||||
|
download_progress,
|
||||||
|
get_distro_info,
|
||||||
|
get_ipv4_addr,
|
||||||
|
get_service_file_path,
|
||||||
|
get_system_timezone,
|
||||||
|
get_upgradable_packages,
|
||||||
|
install_python_packages,
|
||||||
|
install_python_requirements,
|
||||||
|
install_system_packages,
|
||||||
|
kill,
|
||||||
|
log_process,
|
||||||
|
parse_packages_from_file,
|
||||||
|
remove_system_service,
|
||||||
|
set_nginx_permissions,
|
||||||
|
unit_file_exists,
|
||||||
|
update_python_pip,
|
||||||
|
update_system_package_lists,
|
||||||
|
upgrade_system_packages,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestKill:
|
||||||
|
def test_exits_with_error(self, monkeypatch) -> None:
|
||||||
|
exited: List[int] = []
|
||||||
|
|
||||||
|
def fake_exit(code: int) -> None:
|
||||||
|
exited.append(code)
|
||||||
|
raise SystemExit(code)
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.sys.exit", fake_exit)
|
||||||
|
with pytest.raises(SystemExit):
|
||||||
|
kill("boom")
|
||||||
|
assert exited == [1]
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckPythonVersion:
|
||||||
|
def test_old(self, monkeypatch) -> None:
|
||||||
|
info = type("VI", (), {"major": 3, "minor": 7})()
|
||||||
|
monkeypatch.setattr("utils.sys_utils.sys.version_info", info)
|
||||||
|
assert check_python_version(3, 8) is False
|
||||||
|
|
||||||
|
def test_current(self, monkeypatch) -> None:
|
||||||
|
info = type("VI", (), {"major": 3, "minor": 9})()
|
||||||
|
monkeypatch.setattr("utils.sys_utils.sys.version_info", info)
|
||||||
|
assert check_python_version(3, 8) is True
|
||||||
|
|
||||||
|
|
||||||
|
class TestParsePackagesFromFile:
|
||||||
|
def test_reads_pkglist(self, tmp_path: Path) -> None:
|
||||||
|
script = tmp_path / "install.sh"
|
||||||
|
script.write_text('PKGLIST="git curl wget"\nOTHER="x"\n')
|
||||||
|
assert parse_packages_from_file(script) == ["git", "curl", "wget"]
|
||||||
|
|
||||||
|
|
||||||
|
class TestCreatePythonVenv:
|
||||||
|
def test_creates_when_missing(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
target = Path("/tmp/venv")
|
||||||
|
|
||||||
|
assert create_python_venv(target) is True
|
||||||
|
assert runs == [
|
||||||
|
["virtualenv", "-p", "/usr/bin/python3", "/tmp/venv"],
|
||||||
|
]
|
||||||
|
|
||||||
|
def test_declines_recreate(self, monkeypatch) -> None:
|
||||||
|
target = Path("/tmp/venv")
|
||||||
|
monkeypatch.setattr("utils.sys_utils.Path.exists", lambda self: self == target)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.get_confirm", lambda *a, **k: False)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.run",
|
||||||
|
lambda *a, **k: pytest.fail("should not recreate when declined"),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert create_python_venv(target) is False
|
||||||
|
|
||||||
|
def test_confirms_recreate(self, monkeypatch) -> None:
|
||||||
|
target = Path("/tmp/venv")
|
||||||
|
state = {"exists": True}
|
||||||
|
removed: List[Path] = []
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_exists(self: Path) -> bool:
|
||||||
|
return state["exists"] and str(self) == str(target)
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
def fake_rmtree(p: Path) -> None:
|
||||||
|
removed.append(p)
|
||||||
|
state["exists"] = False
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.Path.exists", fake_exists)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.get_confirm", lambda *a, **k: True)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.shutil.rmtree", fake_rmtree)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
|
||||||
|
assert (
|
||||||
|
create_python_venv(target, allow_access_to_system_site_packages=True)
|
||||||
|
is True
|
||||||
|
)
|
||||||
|
assert removed == [target]
|
||||||
|
assert runs == [
|
||||||
|
[
|
||||||
|
"virtualenv",
|
||||||
|
"-p",
|
||||||
|
"/usr/bin/python3",
|
||||||
|
"/tmp/venv",
|
||||||
|
"--system-site-packages",
|
||||||
|
],
|
||||||
|
]
|
||||||
|
|
||||||
|
def test_force_recreate(self, monkeypatch) -> None:
|
||||||
|
target = Path("/tmp/venv")
|
||||||
|
state = {"exists": True}
|
||||||
|
removed: List[Path] = []
|
||||||
|
|
||||||
|
def fake_exists(self: Path) -> bool:
|
||||||
|
return state["exists"] and str(self) == str(target)
|
||||||
|
|
||||||
|
def fake_rmtree(p: Path) -> None:
|
||||||
|
removed.append(p)
|
||||||
|
state["exists"] = False
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.Path.exists", fake_exists)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.get_confirm",
|
||||||
|
lambda *a, **k: pytest.fail("should not prompt when forced"),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.shutil.rmtree", fake_rmtree)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", lambda *a, **k: None)
|
||||||
|
|
||||||
|
assert create_python_venv(target, force=True) is True
|
||||||
|
assert removed == [target]
|
||||||
|
|
||||||
|
def test_creation_failure(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.run",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(CalledProcessError(1, "virtualenv")),
|
||||||
|
)
|
||||||
|
assert create_python_venv(Path("/tmp/venv")) is False
|
||||||
|
|
||||||
|
def test_remove_failure(self, monkeypatch) -> None:
|
||||||
|
target = Path("/tmp/venv")
|
||||||
|
|
||||||
|
def fake_exists(self: Path) -> bool:
|
||||||
|
return str(self) == str(target)
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.Path.exists", fake_exists)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.get_confirm", lambda *a, **k: True)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.shutil.rmtree",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(OSError("locked")),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert create_python_venv(target) is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestUpdatePythonPip:
|
||||||
|
def test_raises_when_pip_missing(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.check_file_exist", lambda *a, **k: False)
|
||||||
|
with pytest.raises(FileNotFoundError):
|
||||||
|
update_python_pip(Path("/tmp/venv"))
|
||||||
|
|
||||||
|
def test_runs_upgrade(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return type("R", (), {"returncode": 0, "stderr": ""})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.check_file_exist", lambda *a, **k: True)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
|
||||||
|
update_python_pip(Path("/tmp/venv"))
|
||||||
|
assert runs == [["/tmp/venv/bin/pip", "install", "-U", "pip"]]
|
||||||
|
|
||||||
|
def test_logs_stderr(self, monkeypatch, capsys) -> None:
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
return type("R", (), {"returncode": 0, "stderr": "some warning"})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.check_file_exist", lambda *a, **k: True)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
|
||||||
|
update_python_pip(Path("/tmp/venv"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstallPythonRequirements:
|
||||||
|
def test_success(self, monkeypatch) -> None:
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
return type("R", (), {"returncode": 0, "stderr": ""})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
install_python_requirements(Path("/tmp/venv"), Path("/tmp/req.txt"))
|
||||||
|
|
||||||
|
def test_failure(self, monkeypatch) -> None:
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
return type("R", (), {"returncode": 1, "stderr": "nope"})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
with pytest.raises(VenvCreationFailedException):
|
||||||
|
install_python_requirements(Path("/tmp/venv"), Path("/tmp/req.txt"))
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstallPythonPackages:
|
||||||
|
def test_success(self, monkeypatch) -> None:
|
||||||
|
captured: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
captured.append(cmd)
|
||||||
|
return type("R", (), {"returncode": 0, "stderr": ""})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
install_python_packages(Path("/tmp/venv"), ["a", "b"])
|
||||||
|
assert captured == [["/tmp/venv/bin/pip", "install", "a", "b"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestUpdateSystemPackageLists:
|
||||||
|
def test_skips_when_recent(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.time.time", lambda: 1000)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.os.path.getmtime", lambda p: 900)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.run",
|
||||||
|
lambda *a, **k: pytest.fail("should not update when recent"),
|
||||||
|
)
|
||||||
|
|
||||||
|
update_system_package_lists(silent=True)
|
||||||
|
|
||||||
|
def test_runs_when_old(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.time.time", lambda: 100_000)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.os.path.getmtime", lambda p: 0)
|
||||||
|
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return type("R", (), {"returncode": 0, "stderr": ""})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
update_system_package_lists(silent=True)
|
||||||
|
|
||||||
|
assert runs == [["sudo", "apt-get", "update"]]
|
||||||
|
|
||||||
|
def test_allows_releaseinfo_change(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.time.time", lambda: 100_000)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.os.path.getmtime", lambda p: 0)
|
||||||
|
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return type("R", (), {"returncode": 0, "stderr": ""})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
update_system_package_lists(silent=True, rls_info_change=True)
|
||||||
|
|
||||||
|
assert runs == [["sudo", "apt-get", "update", "--allow-releaseinfo-change"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetUpgradablePackages:
|
||||||
|
def test_parses_apt_list(self, monkeypatch) -> None:
|
||||||
|
output = (
|
||||||
|
"package1/stable 1.0 [upgradable from: 0.9]\n"
|
||||||
|
"package2/testing 2.0 [upgradable from: 1.0]\n"
|
||||||
|
)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.check_output", lambda *a, **k: output)
|
||||||
|
assert get_upgradable_packages() == ["package1", "package2"]
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckPackageInstall:
|
||||||
|
def test_detects_installed(self, monkeypatch) -> None:
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
return type("R", (), {"stdout": "install ok installed"})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
assert check_package_install({"git"}) == []
|
||||||
|
|
||||||
|
def test_detects_missing(self, monkeypatch) -> None:
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
return type("R", (), {"stdout": "not-installed"})()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
assert check_package_install({"missing"}) == ["missing"]
|
||||||
|
|
||||||
|
|
||||||
|
class TestInstallSystemPackages:
|
||||||
|
def test_runs_apt(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
install_system_packages(["git", "curl"])
|
||||||
|
assert runs == [["sudo", "apt-get", "install", "-y", "git", "curl"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestUpgradeSystemPackages:
|
||||||
|
def test_runs_apt(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
upgrade_system_packages(["git"])
|
||||||
|
assert runs == [["sudo", "apt-get", "upgrade", "-y", "git"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetIpv4Addr:
|
||||||
|
def test_returns_socket_address(self, monkeypatch) -> None:
|
||||||
|
class FakeSocket:
|
||||||
|
def __init__(self, *args):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def settimeout(self, value: float) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def connect(self, addr: tuple) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def getsockname(self) -> tuple:
|
||||||
|
return ("192.168.1.50", 54321)
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.socket.socket", FakeSocket)
|
||||||
|
assert get_ipv4_addr() == "192.168.1.50"
|
||||||
|
|
||||||
|
def test_falls_back_to_loopback(self, monkeypatch) -> None:
|
||||||
|
class FakeSocket:
|
||||||
|
def __init__(self, *args):
|
||||||
|
pass
|
||||||
|
|
||||||
|
def settimeout(self, value: float) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
def connect(self, addr: tuple) -> None:
|
||||||
|
raise OSError("no route")
|
||||||
|
|
||||||
|
def close(self) -> None:
|
||||||
|
pass
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.socket.socket", FakeSocket)
|
||||||
|
assert get_ipv4_addr() == "127.0.0.1"
|
||||||
|
|
||||||
|
|
||||||
|
class TestDownloadFile:
|
||||||
|
def test_without_progress(self, monkeypatch) -> None:
|
||||||
|
calls: List[tuple] = []
|
||||||
|
|
||||||
|
def fake_urlretrieve(url: str, target: Path, reporthook=None) -> None:
|
||||||
|
calls.append((url, str(target), reporthook))
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.urllib.request.urlretrieve", fake_urlretrieve
|
||||||
|
)
|
||||||
|
download_file("http://x/file", Path("/target"), show_progress=False)
|
||||||
|
assert calls == [("http://x/file", "/target", None)]
|
||||||
|
|
||||||
|
def test_with_progress(self, monkeypatch) -> None:
|
||||||
|
calls: List[tuple] = []
|
||||||
|
|
||||||
|
def fake_urlretrieve(url: str, target: Path, reporthook=None) -> None:
|
||||||
|
calls.append((url, str(target), reporthook))
|
||||||
|
if reporthook:
|
||||||
|
reporthook(1, 1024, 2048)
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.urllib.request.urlretrieve", fake_urlretrieve
|
||||||
|
)
|
||||||
|
download_file("http://x/file", Path("/target"), show_progress=True)
|
||||||
|
assert calls[0][2] is not None
|
||||||
|
|
||||||
|
|
||||||
|
class TestDownloadProgress:
|
||||||
|
def test_writes_to_stdout(self, capsys) -> None:
|
||||||
|
download_progress(1, 1024, 2048)
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert "Downloading:" in captured.out
|
||||||
|
assert "50.00%" in captured.out
|
||||||
|
|
||||||
|
|
||||||
|
class TestSetNginxPermissions:
|
||||||
|
def test_no_change_when_executable(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.run",
|
||||||
|
lambda cmd, **kwargs: type("R", (), {"stdout": "drwxr-xr-x"})()
|
||||||
|
if "ls" in cmd
|
||||||
|
else pytest.fail("should not chmod"),
|
||||||
|
)
|
||||||
|
set_nginx_permissions()
|
||||||
|
|
||||||
|
def test_adds_execute(self, monkeypatch) -> None:
|
||||||
|
commands: List[Any] = []
|
||||||
|
|
||||||
|
def fake_run(cmd, **kwargs):
|
||||||
|
commands.append(cmd)
|
||||||
|
if isinstance(cmd, str):
|
||||||
|
return type("R", (), {"stdout": "drwxr------"})()
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
monkeypatch.setattr("utils.sys_utils.Path.home", lambda: Path("/home/user"))
|
||||||
|
set_nginx_permissions()
|
||||||
|
assert ["chmod", "og+x", Path("/home/user")] in commands
|
||||||
|
|
||||||
|
|
||||||
|
class TestCmdSysctlService:
|
||||||
|
def test_runs_systemctl(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
cmd_sysctl_service("klipper", "restart")
|
||||||
|
assert runs == [["sudo", "systemctl", "restart", "klipper"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestCmdSysctlManage:
|
||||||
|
def test_runs_systemctl(self, monkeypatch) -> None:
|
||||||
|
runs: List[List[str]] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append(cmd)
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
cmd_sysctl_manage("daemon-reload")
|
||||||
|
assert runs == [["sudo", "systemctl", "daemon-reload"]]
|
||||||
|
|
||||||
|
|
||||||
|
class TestUnitFileExists:
|
||||||
|
def test_finds_matching_service(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.SYSTEMD", tmp_path)
|
||||||
|
(tmp_path / "klipper.service").write_text("")
|
||||||
|
(tmp_path / "klipper-1.service").write_text("")
|
||||||
|
(tmp_path / "moonraker.service").write_text("")
|
||||||
|
|
||||||
|
assert unit_file_exists("klipper", "service") is True
|
||||||
|
assert unit_file_exists("moonraker", "service") is True
|
||||||
|
assert unit_file_exists("klipper", "timer") is False
|
||||||
|
|
||||||
|
def test_respects_exclude(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.SYSTEMD", tmp_path)
|
||||||
|
(tmp_path / "klipper-mcu.service").write_text("")
|
||||||
|
|
||||||
|
assert unit_file_exists("klipper", "service", exclude=["mcu"]) is False
|
||||||
|
|
||||||
|
|
||||||
|
class TestLogProcess:
|
||||||
|
def test_prints_stdout(self, monkeypatch, capsys) -> None:
|
||||||
|
lines = iter(["line1\n", "line2\n", ""])
|
||||||
|
poll_results = iter([None, 0])
|
||||||
|
|
||||||
|
class FakeStdout:
|
||||||
|
def fileno(self) -> int:
|
||||||
|
return 7
|
||||||
|
|
||||||
|
def readline(self) -> str:
|
||||||
|
return next(lines)
|
||||||
|
|
||||||
|
class FakeProcess:
|
||||||
|
stdout = FakeStdout()
|
||||||
|
|
||||||
|
def poll(self):
|
||||||
|
return next(poll_results)
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.select.select", lambda r, w, x: ([7], [], [])
|
||||||
|
)
|
||||||
|
log_process(FakeProcess()) # type: ignore[arg-type]
|
||||||
|
|
||||||
|
captured = capsys.readouterr()
|
||||||
|
assert "line1" in captured.out
|
||||||
|
assert "line2" in captured.out
|
||||||
|
|
||||||
|
|
||||||
|
class TestCreateServiceFile:
|
||||||
|
def test_writes_via_tee(self, monkeypatch) -> None:
|
||||||
|
runs: List[tuple] = []
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
runs.append((cmd, kwargs.get("input")))
|
||||||
|
return None
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.SYSTEMD", Path("/etc/systemd/system"))
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
create_service_file("klipper.service", "[Unit]\n")
|
||||||
|
|
||||||
|
assert runs[0][0] == [
|
||||||
|
"sudo",
|
||||||
|
"tee",
|
||||||
|
Path("/etc/systemd/system/klipper.service"),
|
||||||
|
]
|
||||||
|
assert runs[0][1] == b"[Unit]\n"
|
||||||
|
|
||||||
|
|
||||||
|
class TestCreateEnvFile:
|
||||||
|
def test_writes_file(self, tmp_path: Path) -> None:
|
||||||
|
path = tmp_path / "env"
|
||||||
|
create_env_file(path, "KEY=value\n")
|
||||||
|
assert path.read_text() == "KEY=value\n"
|
||||||
|
|
||||||
|
|
||||||
|
class TestRemoveSystemService:
|
||||||
|
def test_rejects_bad_name(self) -> None:
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
remove_system_service("klipper")
|
||||||
|
|
||||||
|
def test_skips_missing_file(self, tmp_path: Path, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.SYSTEMD", tmp_path)
|
||||||
|
remove_system_service("klipper.service")
|
||||||
|
|
||||||
|
def test_full_removal(self, monkeypatch) -> None:
|
||||||
|
sysd = Path("/fake/systemd")
|
||||||
|
service_file = sysd / "klipper.service"
|
||||||
|
monkeypatch.setattr("utils.sys_utils.SYSTEMD", sysd)
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.Path.exists",
|
||||||
|
lambda self: str(self) == str(service_file),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.Path.is_file",
|
||||||
|
lambda self: str(self) == str(service_file),
|
||||||
|
)
|
||||||
|
|
||||||
|
service_calls: List[tuple] = []
|
||||||
|
manage_calls: List[str] = []
|
||||||
|
removed: List[Path] = []
|
||||||
|
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.cmd_sysctl_service",
|
||||||
|
lambda name, action: service_calls.append((name, action)),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.cmd_sysctl_manage",
|
||||||
|
lambda action: manage_calls.append(action),
|
||||||
|
)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.remove_with_sudo", lambda p: removed.append(p)
|
||||||
|
)
|
||||||
|
|
||||||
|
remove_system_service("klipper.service")
|
||||||
|
|
||||||
|
assert service_calls == [
|
||||||
|
("klipper.service", "stop"),
|
||||||
|
("klipper.service", "disable"),
|
||||||
|
]
|
||||||
|
assert removed == [service_file]
|
||||||
|
assert manage_calls == ["daemon-reload", "reset-failed"]
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeInstanceType:
|
||||||
|
pass
|
||||||
|
|
||||||
|
|
||||||
|
_FakeInstanceType.__name__ = "Klipper"
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetServiceFilePath:
|
||||||
|
def test_builds_path(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr("utils.sys_utils.SYSTEMD", Path("/etc/systemd/system"))
|
||||||
|
assert get_service_file_path(_FakeInstanceType, "") == Path(
|
||||||
|
"/etc/systemd/system/klipper.service"
|
||||||
|
)
|
||||||
|
assert get_service_file_path(_FakeInstanceType, "1") == Path(
|
||||||
|
"/etc/systemd/system/klipper-1.service"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetDistroInfo:
|
||||||
|
def test_parses_os_release(self, monkeypatch) -> None:
|
||||||
|
content = """
|
||||||
|
ID="ubuntu"
|
||||||
|
ID_LIKE="debian"
|
||||||
|
VERSION_ID="22.04"
|
||||||
|
"""
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.check_output", lambda *a, **k: content.encode()
|
||||||
|
)
|
||||||
|
assert get_distro_info() == ("ubuntu", "22.04")
|
||||||
|
|
||||||
|
def test_remaps_raspbian(self, monkeypatch) -> None:
|
||||||
|
content = """
|
||||||
|
ID="raspbian"
|
||||||
|
ID_LIKE="debian"
|
||||||
|
VERSION_ID="11"
|
||||||
|
"""
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.check_output", lambda *a, **k: content.encode()
|
||||||
|
)
|
||||||
|
assert get_distro_info() == ("debian", "11")
|
||||||
|
|
||||||
|
def test_raises_on_missing_id(self, monkeypatch) -> None:
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.check_output", lambda *a, **k: b'VERSION_ID="1"\n'
|
||||||
|
)
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
get_distro_info()
|
||||||
|
|
||||||
|
|
||||||
|
class TestGetSystemTimezone:
|
||||||
|
def test_from_etc_timezone(self, monkeypatch) -> None:
|
||||||
|
def fake_open(path: str, mode: str = "r", *args, **kwargs):
|
||||||
|
if path == "/etc/timezone":
|
||||||
|
return StringIO("Europe/Berlin\n")
|
||||||
|
return builtins.open(path, mode, *args, **kwargs)
|
||||||
|
|
||||||
|
monkeypatch.setattr("builtins.open", fake_open)
|
||||||
|
assert get_system_timezone() == "Europe/Berlin"
|
||||||
|
|
||||||
|
def test_fallback_to_timedatectl(self, monkeypatch) -> None:
|
||||||
|
def fake_open(path: str, mode: str = "r", *args, **kwargs):
|
||||||
|
raise FileNotFoundError(path)
|
||||||
|
|
||||||
|
monkeypatch.setattr("builtins.open", fake_open)
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
class Result:
|
||||||
|
stdout = "Timezone=America/New_York\n"
|
||||||
|
|
||||||
|
return Result()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
assert get_system_timezone() == "America/New_York"
|
||||||
|
|
||||||
|
def test_fallback_to_readlink(self, monkeypatch) -> None:
|
||||||
|
def fake_open(path: str, mode: str = "r", *args, **kwargs):
|
||||||
|
raise FileNotFoundError(path)
|
||||||
|
|
||||||
|
monkeypatch.setattr("builtins.open", fake_open)
|
||||||
|
|
||||||
|
def fake_run(cmd: List[str], **kwargs: Any) -> Any:
|
||||||
|
if cmd[:2] == ["timedatectl", "show"]:
|
||||||
|
raise CalledProcessError(1, "timedatectl")
|
||||||
|
|
||||||
|
class Result:
|
||||||
|
stdout = "/usr/share/zoneinfo/Asia/Tokyo\n"
|
||||||
|
|
||||||
|
return Result()
|
||||||
|
|
||||||
|
monkeypatch.setattr("utils.sys_utils.run", fake_run)
|
||||||
|
assert get_system_timezone() == "Asia/Tokyo"
|
||||||
|
|
||||||
|
def test_defaults_to_utc(self, monkeypatch) -> None:
|
||||||
|
def fake_open(path: str, mode: str = "r", *args, **kwargs):
|
||||||
|
raise FileNotFoundError(path)
|
||||||
|
|
||||||
|
monkeypatch.setattr("builtins.open", fake_open)
|
||||||
|
monkeypatch.setattr(
|
||||||
|
"utils.sys_utils.run",
|
||||||
|
lambda *a, **k: (_ for _ in ()).throw(CalledProcessError(1, "timedatectl")),
|
||||||
|
)
|
||||||
|
assert get_system_timezone() == "UTC"
|
||||||
+9
-2
@@ -2,7 +2,7 @@
|
|||||||
requires-python = ">=3.8"
|
requires-python = ">=3.8"
|
||||||
|
|
||||||
[project.optional-dependencies]
|
[project.optional-dependencies]
|
||||||
dev=["ruff", "mypy", "pytest"]
|
dev=["ruff", "mypy", "pytest", "paramiko", "pytest-testinfra", "pyyaml", "python-dotenv"]
|
||||||
|
|
||||||
[tool.ruff]
|
[tool.ruff]
|
||||||
required-version = ">=0.9.10"
|
required-version = ">=0.9.10"
|
||||||
@@ -33,5 +33,12 @@ warn_unreachable = true
|
|||||||
|
|
||||||
[tool.pytest.ini_options]
|
[tool.pytest.ini_options]
|
||||||
minversion = "8.2.1"
|
minversion = "8.2.1"
|
||||||
testpaths = ["kiauh/core/simple_config_parser/tests"]
|
testpaths = [
|
||||||
|
"kiauh/core/simple_config_parser/tests",
|
||||||
|
"kiauh/live/tests",
|
||||||
|
"kiauh/utils/tests",
|
||||||
|
]
|
||||||
pythonpath = ["kiauh"]
|
pythonpath = ["kiauh"]
|
||||||
|
markers = [
|
||||||
|
"live: tests that run against a real VM (isolated, never local)",
|
||||||
|
]
|
||||||
|
|||||||
@@ -1,3 +1,7 @@
|
|||||||
ruff (>=0.9.10)
|
ruff (>=0.9.10)
|
||||||
mypy
|
mypy
|
||||||
pytest
|
pytest
|
||||||
|
paramiko
|
||||||
|
pytest-testinfra
|
||||||
|
pyyaml
|
||||||
|
python-dotenv
|
||||||
|
|||||||
Reference in New Issue
Block a user