mirror of
https://github.com/dw-0/kiauh.git
synced 2026-08-03 21:07:53 +05:00
Compare commits
16
Commits
v6.1.1
...
7b5522ac94
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7b5522ac94 | ||
|
|
a42b730688 | ||
|
|
77d6c87aa0 | ||
|
|
b893ff14f7 | ||
|
|
43b0994ac5 | ||
|
|
040edc1d4f | ||
|
|
750dba1dbe | ||
|
|
6f4b471008 | ||
|
|
5077765fd6 | ||
|
|
9f97ae6c2a | ||
|
|
b90a8f13b1 | ||
|
|
ea1b794afd | ||
|
|
647a7d9400 | ||
|
|
aa0609d143 | ||
|
|
2175bd55f9 | ||
|
|
a935e67431 |
@@ -7,6 +7,7 @@
|
||||
*.tmp
|
||||
__pycache__
|
||||
.kiauh-env
|
||||
.venv
|
||||
*.code-workspace
|
||||
*.iml
|
||||
kiauh.cfg
|
||||
|
||||
@@ -122,9 +122,9 @@ changes!**
|
||||
|
||||
<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>
|
||||
<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>
|
||||
@@ -140,67 +140,88 @@ changes!**
|
||||
<th>by <a href="https://github.com/Arksine">Arksine</a></th>
|
||||
<th>by <a href="https://github.com/mainsail-crew">mainsail-crew</a></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<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/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
||||
<th></th>
|
||||
</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://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" 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><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/KlipperScreen?v=4" alt="KlipperScreen Logo" height="64"></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<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/OctoPrint">OctoPrint</a></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2 align="center">🧩 Community Extensions 🧩</h2>
|
||||
|
||||
<table align="center" style="text-align: center;">
|
||||
<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/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>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></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/OctoPrint/OctoPrint"><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></a></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><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>
|
||||
<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/Kragrathea">Kragrathea</a></th>
|
||||
<th>by <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
||||
</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://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>
|
||||
<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://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>
|
||||
<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/QuinnDamerell">Quinn Damerell</a></th>
|
||||
<th>by <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
||||
</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://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
||||
</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/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>
|
||||
<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/SimplyPrint">SimplyPrint</a></th>
|
||||
</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>
|
||||
|
||||
<hr>
|
||||
@@ -229,13 +250,3 @@ changes!**
|
||||
a [Ko-fi](https://ko-fi.com/dw__0) !
|
||||
* Last but not least: Thank you to all contributors and members of the Klipper
|
||||
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">
|
||||
<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>
|
||||
</a>
|
||||
</p>
|
||||
@@ -34,13 +34,13 @@ KIAUH 是一个帮助您在 Linux 系统上安装 Klipper 的脚本工具,
|
||||
选择 `Choose OS -> Raspberry Pi OS (other)`:
|
||||
|
||||
<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>
|
||||
|
||||
* 然后选择 `Raspberry Pi OS Lite (32位)` (或如果您想使用64位版本):
|
||||
|
||||
<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>
|
||||
|
||||
* 返回 Raspberry Pi Imager 主界面,选择对应的 SD 卡作为写入目标。
|
||||
@@ -99,9 +99,9 @@ cd ~ && git clone https://github.com/dw-0/kiauh.git
|
||||
您会被要求输入 sudo 密码。
|
||||
因为有几个功能需要 sudo 权限。
|
||||
|
||||
## 🌐 相关资源与更多信息
|
||||
<h2 align="center">⚙️ 核心组件 ⚙️</h2>
|
||||
|
||||
<table align="center">
|
||||
<table align="center" style="text-align: center;">
|
||||
<tr>
|
||||
<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>
|
||||
@@ -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/mainsail-crew">mainsail-crew</a></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<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/OctoPrint/OctoPrint">OctoPrint</a></h3></th>
|
||||
<th><h3><a href="https://github.com/KlipperScreen/KlipperScreen">KlipperScreen</a></h3></th>
|
||||
<th></th>
|
||||
</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://avatars.githubusercontent.com/u/31575189?v=4" alt="jordanruthe avatar" 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><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/KlipperScreen?v=4" alt="KlipperScreen Logo" height="64"></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<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/OctoPrint">OctoPrint</a></th>
|
||||
<th>由 <a href="https://github.com/alfrix">alfrix</a></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<hr>
|
||||
|
||||
<h2 align="center">🧩 社区扩展 🧩</h2>
|
||||
|
||||
<table align="center" style="text-align: center;">
|
||||
<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/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>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/52351624?v=4" alt="nlef avatar" height="64"></th>
|
||||
<th><img src="https://avatars.githubusercontent.com/u/5917231?v=4" alt="Kragrathea avatar" height="64"></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/OctoPrint/OctoPrint"><img src="https://raw.githubusercontent.com/OctoPrint/OctoPrint/master/docs/images/octoprint-logo.png" alt="OctoPrint Logo" height="64"></a></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><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>
|
||||
<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/Kragrathea">Kragrathea</a></th>
|
||||
<th>由 <a href="https://github.com/TheSpaghettiDetective">Obico</a></th>
|
||||
</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://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>
|
||||
<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://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>
|
||||
<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/QuinnDamerell">Quinn Damerell</a></th>
|
||||
<th>由 <a href="https://github.com/crysxd">Christian Würthner</a></th>
|
||||
</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://simplyprint.io/">SimplyPrint for Klipper</a></h3></th>
|
||||
</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/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>
|
||||
<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/SimplyPrint">SimplyPrint</a></th>
|
||||
</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>
|
||||
|
||||
## 🎖️ 贡献者
|
||||
<hr>
|
||||
|
||||
<h2 align="center">🎖️ 贡献者 🎖️</h2>
|
||||
|
||||
<div align="center">
|
||||
<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"/>
|
||||
</div>
|
||||
|
||||
## ✨ 特别感谢
|
||||
<hr>
|
||||
|
||||
<h2 align="center">✨ 特别感谢 ✨</h2>
|
||||
|
||||
* 非常感谢 [lixxbox](https://github.com/lixxbox) 设计了如此出色的 KIAUH 标志!
|
||||
* 同时,非常感谢所有通过 [Ko-fi](https://ko-fi.com/dw__0) 支持我的工作的人!
|
||||
* 最后但同样重要的是:感谢所有为 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>
|
||||
|
||||
@@ -15,18 +15,30 @@ clear -x
|
||||
# make sure we have the correct permissions while running the script
|
||||
umask 022
|
||||
|
||||
# gets the path where this script is located
|
||||
KIAUH_SRCDIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd)
|
||||
|
||||
# colors
|
||||
white="\033[37m"
|
||||
cyan="\033[96m"
|
||||
red="\033[91m"
|
||||
yellow="\033[93m"
|
||||
green="\033[92m"
|
||||
|
||||
#===================================================#
|
||||
#=================== UPDATE KIAUH ==================#
|
||||
#===================================================#
|
||||
|
||||
function update_kiauh() {
|
||||
status_msg "Updating KIAUH ..."
|
||||
echo "Updating KIAUH ..."
|
||||
|
||||
cd "${KIAUH_SRCDIR}"
|
||||
git reset --hard && git pull
|
||||
|
||||
ok_msg "Update complete! Please restart KIAUH."
|
||||
exit 0
|
||||
echo "Update complete! Restarting..."
|
||||
sleep 1
|
||||
exec "$0" "$@" # restarts the script
|
||||
|
||||
}
|
||||
|
||||
#===================================================#
|
||||
@@ -65,16 +77,18 @@ function kiauh_update_dialog() {
|
||||
echo -e "\-------------------------------------------------------/"
|
||||
|
||||
local yn
|
||||
read -p "${cyan}###### Do you want to update now? (Y/n):${white} " yn
|
||||
echo -ne "${cyan}###### Do you want to update now? (Y/n):${white} "
|
||||
read yn
|
||||
while true; do
|
||||
case "${yn}" in
|
||||
Y|y|Yes|yes|"")
|
||||
do_action "update_kiauh"
|
||||
update_kiauh
|
||||
break;;
|
||||
N|n|No|no)
|
||||
break;;
|
||||
*)
|
||||
deny_action "kiauh_update_dialog";;
|
||||
echo -e "${red}Invalid input. Please try again.${white}"
|
||||
kiauh_update_dialog;;
|
||||
esac
|
||||
done
|
||||
}
|
||||
|
||||
@@ -19,10 +19,12 @@ CROWSNEST_SERVICE_NAME = "crowsnest.service"
|
||||
|
||||
# directories
|
||||
CROWSNEST_DIR = Path.home().joinpath("crowsnest")
|
||||
CROWSNEST_ENV_DIR = Path.home().joinpath("crowsnest-env")
|
||||
|
||||
# files
|
||||
CROWSNEST_MULTI_CONFIG = CROWSNEST_DIR.joinpath("tools/.config")
|
||||
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_LOGROTATE_FILE = Path("/etc/logrotate.d/crowsnest")
|
||||
CROWSNEST_SERVICE_FILE = SYSTEMD.joinpath(CROWSNEST_SERVICE_NAME)
|
||||
|
||||
@@ -16,7 +16,9 @@ from typing import List
|
||||
|
||||
from components.crowsnest import (
|
||||
CROWSNEST_BIN_FILE,
|
||||
CROWSNEST_DEPS_JSON_FILE,
|
||||
CROWSNEST_DIR,
|
||||
CROWSNEST_ENV_DIR,
|
||||
CROWSNEST_INSTALL_SCRIPT,
|
||||
CROWSNEST_LOGROTATE_FILE,
|
||||
CROWSNEST_MULTI_CONFIG,
|
||||
@@ -25,6 +27,8 @@ from components.crowsnest import (
|
||||
CROWSNEST_SERVICE_NAME,
|
||||
)
|
||||
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.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings
|
||||
@@ -34,6 +38,7 @@ from utils.common import (
|
||||
get_install_status,
|
||||
)
|
||||
from utils.git_utils import (
|
||||
get_current_branch,
|
||||
git_clone_wrapper,
|
||||
git_pull_wrapper,
|
||||
)
|
||||
@@ -47,7 +52,7 @@ from utils.sys_utils import (
|
||||
|
||||
def install_crowsnest() -> None:
|
||||
# Step 1: Clone crowsnest repo
|
||||
git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR, "master")
|
||||
git_clone_wrapper(CROWSNEST_REPO, CROWSNEST_DIR)
|
||||
|
||||
# Step 2: Install dependencies
|
||||
check_install_dependencies({"make"})
|
||||
@@ -135,8 +140,7 @@ def update_crowsnest() -> None:
|
||||
|
||||
git_pull_wrapper(CROWSNEST_DIR)
|
||||
|
||||
deps = parse_packages_from_file(CROWSNEST_INSTALL_SCRIPT)
|
||||
check_install_dependencies({*deps})
|
||||
install_crowsnest_packages()
|
||||
|
||||
cmd_sysctl_service(CROWSNEST_SERVICE_NAME, "restart")
|
||||
|
||||
@@ -147,12 +151,68 @@ def update_crowsnest() -> None:
|
||||
|
||||
|
||||
def get_crowsnest_status() -> ComponentStatus:
|
||||
files = [
|
||||
CROWSNEST_BIN_FILE,
|
||||
CROWSNEST_LOGROTATE_FILE,
|
||||
CROWSNEST_SERVICE_FILE,
|
||||
]
|
||||
return get_install_status(CROWSNEST_DIR, files=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_LOGROTATE_FILE,
|
||||
CROWSNEST_SERVICE_FILE,
|
||||
],
|
||||
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:
|
||||
|
||||
@@ -34,7 +34,7 @@ from core.constants import CURRENT_USER
|
||||
from core.instance_manager.base_instance import SUFFIX_BLACKLIST
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from core.types.component_status import ComponentStatus
|
||||
|
||||
@@ -25,7 +25,7 @@ from components.moonraker import (
|
||||
from core.constants import CURRENT_USER
|
||||
from core.instance_manager.base_instance import BaseInstance
|
||||
from core.logger import Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from utils.fs_utils import create_folders
|
||||
|
||||
@@ -25,7 +25,7 @@ from components.moonraker.utils.sysdeps_parser import SysDepsParser
|
||||
from components.webui_client.base_data import BaseWebClient
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from core.types.component_status import ComponentStatus
|
||||
|
||||
@@ -33,7 +33,7 @@ from core.constants import (
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.settings.kiauh_settings import KiauhSettings, WebUiSettings
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from core.types.color import Color
|
||||
|
||||
@@ -16,7 +16,7 @@ from components.klipper import KLIPPER_REPO_URL
|
||||
from components.moonraker import MOONRAKER_REPO_URL
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from utils.input_utils import get_confirm
|
||||
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+2
-2
@@ -10,8 +10,8 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from tests.utils import load_testdata_from_file
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.tests.utils import load_testdata_from_file
|
||||
|
||||
BASE_DIR = Path(__file__).parent.joinpath("test_data")
|
||||
MATCHING_TEST_DATA_PATH = BASE_DIR.joinpath("matching_data.txt")
|
||||
+1
-1
@@ -10,7 +10,7 @@ from typing import List
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
BlankLine,
|
||||
CommentLine,
|
||||
MLOptionValue,
|
||||
+1
-1
@@ -3,7 +3,7 @@
|
||||
# ======================================================================= #
|
||||
from pathlib import Path
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
BlankLine,
|
||||
MultiLineOption,
|
||||
SimpleConfigParser,
|
||||
+1
-1
@@ -9,7 +9,7 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
|
||||
BASE_DIR = Path(__file__).parent.parent.joinpath("assets")
|
||||
CONFIG_FILES = [
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
from pathlib import Path
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import Gcode, SimpleConfigParser
|
||||
from core.simple_config_parser.simple_config_parser import Gcode, SimpleConfigParser
|
||||
|
||||
ASSETS = Path(__file__).parent.parent / "assets"
|
||||
GCODE_FILE = ASSETS / "test_gcode.cfg"
|
||||
+1
-1
@@ -8,7 +8,7 @@
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
MultiLineOption,
|
||||
NoOptionError,
|
||||
NoSectionError,
|
||||
+1
-1
@@ -7,7 +7,7 @@
|
||||
# ======================================================================= #
|
||||
from pathlib import Path
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import Section, SimpleConfigParser
|
||||
from core.simple_config_parser.simple_config_parser import Section, SimpleConfigParser
|
||||
|
||||
BASE_DIR = Path(__file__).parent.parent / "assets"
|
||||
TEST_DATA_PATH = BASE_DIR / "test_config_1.cfg"
|
||||
+1
-1
@@ -8,7 +8,7 @@
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
DuplicateSectionError,
|
||||
)
|
||||
|
||||
+1
-1
@@ -9,7 +9,7 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
|
||||
BASE_DIR = Path(__file__).parent.parent / "assets"
|
||||
TEST_DATA_PATH = BASE_DIR / "test_config_1.cfg"
|
||||
+1
-1
@@ -9,7 +9,7 @@ from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from src.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
from core.simple_config_parser.simple_config_parser import SimpleConfigParser
|
||||
|
||||
BASE_DIR = Path(__file__).parent.parent / "assets"
|
||||
TEST_DATA_PATH = BASE_DIR / "test_config_1.cfg"
|
||||
@@ -1,13 +0,0 @@
|
||||
# see https://editorconfig.org/
|
||||
root = true
|
||||
|
||||
[*]
|
||||
end_of_line = lf
|
||||
trim_trailing_whitespace = true
|
||||
indent_style = space
|
||||
insert_final_newline = true
|
||||
indent_size = 4
|
||||
charset = utf-8
|
||||
|
||||
[*.py]
|
||||
max_line_length = 88
|
||||
@@ -1,13 +0,0 @@
|
||||
*.py[cod]
|
||||
*.pyc
|
||||
__pycache__
|
||||
.pytest_cache/
|
||||
|
||||
.idea/
|
||||
.vscode/
|
||||
|
||||
.venv*/
|
||||
venv*/
|
||||
|
||||
.coverage
|
||||
htmlcov/
|
||||
@@ -1,674 +0,0 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
@@ -1,66 +0,0 @@
|
||||
[project]
|
||||
name = "simple-config-parser"
|
||||
version = "0.0.1"
|
||||
description = "A simple config parser for Python"
|
||||
authors = [
|
||||
{name = "Dominik Willner", email = "th33xitus@gmail.com"},
|
||||
]
|
||||
readme = "README.md"
|
||||
license = {text = "GPL-3.0-only"}
|
||||
requires-python = ">=3.8"
|
||||
|
||||
[project.urls]
|
||||
homepage = "https://github.com/dw-0/simple-config-parser"
|
||||
repository = "https://github.com/dw-0/simple-config-parser"
|
||||
documentation = "https://github.com/dw-0/simple-config-parser"
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev=["ruff"]
|
||||
|
||||
[tool.ruff]
|
||||
required-version = ">=0.3.4"
|
||||
respect-gitignore = true
|
||||
exclude = [".git",".github", "./docs"]
|
||||
line-length = 88
|
||||
indent-width = 4
|
||||
output-format = "full"
|
||||
|
||||
[tool.ruff.format]
|
||||
indent-style = "space"
|
||||
line-ending = "lf"
|
||||
quote-style = "double"
|
||||
|
||||
[tool.ruff.lint]
|
||||
extend-select = ["I"]
|
||||
|
||||
[tool.pytest.ini_options]
|
||||
minversion = "8.2.1"
|
||||
testpaths = ["tests/**/*.py"]
|
||||
addopts = "-svvv --cov --cov-config=pyproject.toml --cov-report=html"
|
||||
|
||||
[tool.coverage.run]
|
||||
branch = true
|
||||
source = ["src.simple_config_parser"]
|
||||
|
||||
[tool.coverage.report]
|
||||
# Regexes for lines to exclude from consideration
|
||||
exclude_also = [
|
||||
# Don't complain about missing debug-only code:
|
||||
"def __repr__",
|
||||
"if self\\.debug",
|
||||
|
||||
# Don't complain if tests don't hit defensive assertion code:
|
||||
"raise AssertionError",
|
||||
"raise NotImplementedError",
|
||||
|
||||
# Don't complain if non-runnable code isn't run:
|
||||
"if 0:",
|
||||
"if __name__ == .__main__.:",
|
||||
|
||||
# Don't complain about abstract methods, they aren't run:
|
||||
"@(abc\\.)?abstractmethod",
|
||||
]
|
||||
|
||||
[tool.coverage.html]
|
||||
title = "SimpleConfigParser Coverage Report"
|
||||
directory = "htmlcov"
|
||||
@@ -1,3 +0,0 @@
|
||||
ruff >= 0.3.4
|
||||
pytest >= 8.2.1
|
||||
pytest-cov >= 5.0.0
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
@@ -16,7 +16,7 @@ from components.klipper.klipper import Klipper
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from extensions.base_extension import BaseExtension
|
||||
|
||||
@@ -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)
|
||||
@@ -16,7 +16,7 @@ from components.moonraker.moonraker import Moonraker
|
||||
from core.constants import CURRENT_USER
|
||||
from core.instance_manager.base_instance import BaseInstance
|
||||
from core.logger import Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from extensions.obico import (
|
||||
|
||||
@@ -15,7 +15,7 @@ from core.instance_manager.base_instance import SUFFIX_BLACKLIST
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import DialogType, Logger
|
||||
from core.services.backup_service import BackupService
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from extensions.base_extension import BaseExtension
|
||||
|
||||
@@ -12,7 +12,7 @@ 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.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from extensions.base_extension import BaseExtension
|
||||
|
||||
@@ -1,5 +1,6 @@
|
||||
# ======================================================================= #
|
||||
# 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 #
|
||||
@@ -14,7 +15,7 @@ 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.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from extensions.base_extension import BaseExtension
|
||||
@@ -82,7 +83,7 @@ class TmcAutotuneExtension(BaseExtension):
|
||||
allow_go_back=False,
|
||||
)
|
||||
|
||||
kl_instances = get_instances(Klipper)
|
||||
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if not stop_klipper_instances_interactively(
|
||||
kl_instances, "installation of TMC Autotune"
|
||||
@@ -120,7 +121,7 @@ class TmcAutotuneExtension(BaseExtension):
|
||||
)
|
||||
|
||||
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)
|
||||
else:
|
||||
Logger.print_info(
|
||||
@@ -170,7 +171,7 @@ class TmcAutotuneExtension(BaseExtension):
|
||||
allow_go_back=True,
|
||||
)
|
||||
|
||||
kl_instances = get_instances(Klipper)
|
||||
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if not stop_klipper_instances_interactively(
|
||||
kl_instances, "update of TMC Autotune"
|
||||
@@ -208,7 +209,7 @@ class TmcAutotuneExtension(BaseExtension):
|
||||
Logger.print_info("Extension does not seem to be installed! Skipping ...")
|
||||
return
|
||||
|
||||
kl_instances = get_instances(Klipper)
|
||||
kl_instances: List[Klipper] = get_instances(Klipper)
|
||||
|
||||
if not stop_klipper_instances_interactively(
|
||||
kl_instances, "removal of TMC Autotune"
|
||||
@@ -344,4 +345,3 @@ class TmcAutotuneExtension(BaseExtension):
|
||||
Logger.print_ok(
|
||||
"Klipper TMC Autotune successfully removed from Moonraker update manager(s)!"
|
||||
)
|
||||
|
||||
|
||||
@@ -31,6 +31,7 @@ from components.moonraker.services.moonraker_setup_service import (
|
||||
from core.instance_manager.instance_manager import InstanceManager
|
||||
from core.logger import Logger
|
||||
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.instance_utils import get_instances
|
||||
from utils.sys_utils import (
|
||||
@@ -47,6 +48,11 @@ class RepoSwitchFailedException(Exception):
|
||||
def run_switch_repo_routine(
|
||||
name: Literal["klipper", "moonraker"], repo_url: str, branch: str
|
||||
) -> 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
|
||||
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
|
||||
@@ -89,7 +95,16 @@ def run_switch_repo_routine(
|
||||
|
||||
# step 6: recreate python 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__}")
|
||||
else:
|
||||
install_python_requirements(env_dir, req_file)
|
||||
|
||||
@@ -36,13 +36,15 @@ from utils.sys_utils import (
|
||||
update_system_package_lists,
|
||||
)
|
||||
|
||||
from kiauh import PROJECT_ROOT
|
||||
|
||||
|
||||
def get_kiauh_version() -> str:
|
||||
"""
|
||||
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
|
||||
"""
|
||||
tags: List[str] = get_local_tags(Path(__file__).parent.parent)
|
||||
tags: List[str] = get_local_tags(PROJECT_ROOT)
|
||||
if tags:
|
||||
return tags[-1]
|
||||
else:
|
||||
|
||||
@@ -14,7 +14,7 @@ from pathlib import Path
|
||||
from typing import List, Tuple, Union
|
||||
|
||||
from core.logger import Logger
|
||||
from core.submodules.simple_config_parser.src.simple_config_parser.simple_config_parser import (
|
||||
from core.simple_config_parser.simple_config_parser import (
|
||||
SimpleConfigParser,
|
||||
)
|
||||
from utils.instance_type import InstanceType
|
||||
|
||||
@@ -67,7 +67,7 @@ def git_pull_wrapper(target_dir: Path) -> None:
|
||||
Logger.print_status("Updating repository ...")
|
||||
try:
|
||||
git_cmd_pull(target_dir)
|
||||
except CalledProcessError:
|
||||
except (CalledProcessError, GitException):
|
||||
log = "An unexpected error occured during updating the repository."
|
||||
Logger.print_error(log)
|
||||
return
|
||||
@@ -102,6 +102,9 @@ def get_current_branch(repo: Path) -> str | None:
|
||||
:param repo: Path to the local Git repository
|
||||
:return: Current branch or None if not determinable
|
||||
"""
|
||||
if not repo.exists() or not repo.joinpath(".git").exists():
|
||||
return None
|
||||
|
||||
try:
|
||||
cmd = ["git", "branch", "--show-current"]
|
||||
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
|
||||
|
||||
except CalledProcessError:
|
||||
except (CalledProcessError, FileNotFoundError):
|
||||
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
|
||||
:return: List of tags
|
||||
"""
|
||||
if not repo_path.exists() or not repo_path.joinpath(".git").is_dir():
|
||||
return []
|
||||
|
||||
def parse_version(version: str) -> tuple:
|
||||
# Remove 'v' prefix if present
|
||||
@@ -337,6 +342,11 @@ def git_cmd_checkout(branch: str | None, target_dir: Path) -> None:
|
||||
if branch is None:
|
||||
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:
|
||||
command = ["git", "checkout", f"{branch}"]
|
||||
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:
|
||||
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:
|
||||
command = ["git", "pull"]
|
||||
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:
|
||||
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"
|
||||
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
|
||||
: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
|
||||
|
||||
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)]
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user