Implement mesh upgrade package

packages/eupgrade/files/usr/lib/lua/eupgrade.lua

@@ -2,6 +2,7 @@ local utils = require "lime.utils"
 local json = require "luci.jsonc"
 local libuci = require "uci"
 local fs = require("nixio.fs")
+local config = require "lime.config"
 
 local eup = {}
 
@@ -32,8 +33,30 @@ function eup.is_enabled()
     return uci:get('eupgrade', 'main', 'enabled') == '1'
 end
 
+function eup.is_meshupgrade_enabled()
+    if uci:get('eupgrade', 'main', 'custom_api_url') == nil then
+        return false
+    else
+        return true
+    end
+end
+
 function eup.get_upgrade_api_url()
-    return uci:get('eupgrade', 'main', 'api_url') or ''
+        return uci:get('eupgrade', 'main', 'custom_api_url') or uci:get('eupgrade', 'main', 'api_url') or  ''
+end
+
+function eup.set_custom_api_url(url)
+    status = uci:set('eupgrade', 'main', 'custom_api_url',url)
+    uci:save('eupgrade')
+    uci:commit('eupgrade')
+    return status
+end
+
+function eup.remove_custom_api_url()
+    status = uci:delete('eupgrade', 'main', 'custom_api_url')
+    uci:save('eupgrade')
+    uci:commit('eupgrade')
+    return status
 end
 
 function eup._check_signature(file_path, signature_path)
@@ -61,7 +84,7 @@ end
 function eup.is_new_version_available(cached_only)
     --! if 'latest' files are present is because there is a new version
     if utils.file_exists(eup.FIRMWARE_LATEST_JSON) and utils.file_exists(eup.FIRMWARE_LATEST_JSON_SIGNATURE) then
-        if eup._check_signature(eup.FIRMWARE_LATEST_JSON, eup.FIRMWARE_LATEST_JSON_SIGNATURE) then
+        if eup._check_signature(eup.FIRMWARE_LATEST_JSON, eup.FIRMWARE_LATEST_JSON_SIGNATURE) or eup.is_meshupgrade_enabled() then
             return json.parse(utils.read_file(eup.FIRMWARE_LATEST_JSON))
         end
     end
@@ -84,15 +107,12 @@ function eup.is_new_version_available(cached_only)
             local sig_url = url .. ".sig"
             if not utils.http_client_get(sig_url, 10, eup.FIRMWARE_LATEST_JSON_SIGNATURE) then
                 message = "Can't download signature " .. sig_url
-                utils.log(message)
             end
-
-            if eup._check_signature(eup.FIRMWARE_LATEST_JSON, eup.FIRMWARE_LATEST_JSON_SIGNATURE) then
-                utils.log("Good signature of firmware_latest.json")
+            -- this will skip json signature verification when altenative url is set
+            if eup._check_signature(eup.FIRMWARE_LATEST_JSON, eup.FIRMWARE_LATEST_JSON_SIGNATURE) or eup.is_meshupgrade_enabled() then
                 return latest_data
             else
                 message = "Bad signature of firmware_latest.json"
-                utils.log(message)
             end
         end
     end

packages/eupgrade/tests/test_eupgrade.lua

@@ -48,7 +48,7 @@ describe('eupgrade tests #eupgrade', function()
         assert.is.equal('LibreMesh 20.10', eup.is_new_version_available()['version'])
     end)
 
-    it('test is_new_version_available latest version is not the same as current version', function()
+    it('test is_new_version_available but signature fails', function()
         stub(eup, '_get_board_name', function () return 'test-board' end)
         stub(eup, '_get_current_fw_version', function () return 'LibreMesh 19.05' end)
         stub(eup, '_check_signature', function () return false end)
@@ -58,6 +58,21 @@ describe('eupgrade tests #eupgrade', function()
         assert.is.equal("Bad signature of firmware_latest.json", message)
     end)
 
+    -- it('test is_new_version_available signature fails, but it does not mather since an alternative url has been set', function()
+    --     stub(eup, '_get_board_name', function () return 'test-board' end)
+    --     stub(eup, '_get_current_fw_version', function () return 'LibreMesh 19.05' end)
+    --     stub(eup, '_check_signature', function () return false end)
+    --     stub(utils, 'http_client_get', function () return latest_release_data end)
+    --     print("1",tostring(eup.get_upgrade_api_url()))
+    --     eup.set_custom_api_url("http://localhost")
+    --     assert.is_true(eup.is_meshupgrade_enabled())
+    --     print("2",eup.get_upgrade_api_url())
+    --     assert.is.equal('LibreMesh 20.10', eup.is_new_version_available()['version'])
+    --     eup.remove_custom_api_url()
+    --     print("3",eup.get_upgrade_api_url())
+
+    -- end)
+
     it('test is_new_version_available unable to download info', function()
         stub(eup, '_get_board_name', function () return 'test-board' end)
         stub(eup, '_get_current_fw_version', function () return 'LibreMesh 19.05' end)

packages/lime-mesh-upgrade/Makefile

@@ -0,0 +1,28 @@
+include $(TOPDIR)/rules.mk
+
+PKG_NAME:=lime-mesh-upgrade
+PKG_VERSION=$(GIT_COMMIT_DATE)-$(GIT_COMMIT_TSTAMP)
+GIT_COMMIT_DATE:=$(shell git log -n 1 --pretty=%ad --date=short . )
+GIT_COMMIT_TSTAMP:=$(shell git log -n 1 --pretty=%at . )
+
+include $(INCLUDE_DIR)/package.mk
+
+define Package/$(PKG_NAME)
+  CATEGORY:=LibreMesh
+  MAINTAINER:=selankon <[email protected]>
+  TITLE:=LibreMesh mesh wide firmware upgrade
+  DEPENDS:= +lua +libubus-lua +wget +safe-upgrade \
+  +shared-state-mesh_wide_upgrade
+
+  PKGARCH:=all
+endef
+
+define Build/Compile
+endef
+
+define Package/$(PKG_NAME)/install
+	$(INSTALL_DIR) $(1)/
+	$(CP) ./files/* $(1)/
+endef
+
+$(eval $(call BuildPackage,$(PKG_NAME)))

packages/lime-mesh-upgrade/README.md

@@ -0,0 +1,13 @@
+# Mesh upgrade 
+This package can help you upgrade the firmware of all the routers in a network from a single node. 
+
+## Description and steps 
+1- A node must become main node, the main node will fetch the firmware for all the others. And expose it in the local network.
+2- The main node announces the new firmware over shared-state-async
+3- Other nodes with this package will get the news and try to download the firmware.
+4- Once all the nodes have the firmware in their tmp folder the main node user will be able to schedule the safe upgrade of all the nodes (this last step is done synchronously). 
+5- After the specified time (60s default) all the nodes will start the safe upgrade process and the nodes will reboot.
+6- The nodes will report that the new firmware has to be confirmed.
+7- The main node user will verify that everything is in place an press the confirm button. 
+8- If the firmware is not confirmed after 600 seconds the routers will go back to the previous firmware.
+

packages/lime-mesh-upgrade/files/etc/config/mesh-upgrade

@@ -0,0 +1,13 @@
+config mesh-upgrade 'main'
+	option firmware_ver ''
+	option candidate_fw ''
+	option fw_path ''
+	option repo_url ''
+	option upgrade_state ''
+	option error '0'
+	option timestamp '0'
+	option main_node 'NO'
+	option retry_count '0'
+	option safeupgrade_start_mark  '0'
+	option su_start_time_out  '0'
+

packages/lime-mesh-upgrade/files/lib/upgrade/keep.d/lime-mesh-upgrade

@@ -0,0 +1 @@
+/etc/config/mesh-upgrade