adding hash of archive + other minor changes

Author: AntoineBuirey

builder-tool/src/builderTool.py

@@ -124,10 +124,14 @@ def __init__(self):
             }
         } #type: dict[str, dict[str, BaseBuilder.RequireMode]]
 
+        self.debugLevel = LEVELS.INFO
+        
         if self.args.debug:
-            Logger.setLevel('stdout', LEVELS.DEBUG)
+            self.debugLevel = LEVELS.DEBUG
         elif self.args.deep_debug:
-            Logger.setLevel('stdout', LEVELS.DEEP_DEBUG)
+            self.debugLevel = LEVELS.DEEP_DEBUG
+            
+        Logger.setLevel('stdout', self.debugLevel)
 
 
         Logger.debug("Using gamuLogger version : " + gamuLogger.__version__)
@@ -158,8 +162,15 @@ def addAndReplaceByPackageVersion(self, src, dest = None, versionString = "{vers
             file.write(content)
         return True
 
-    def runCommand(self, command, hideOutput = True) -> bool:
-        """Execute a command in the temporary directory"""
+    def runCommand(self, command : str, hideOutput = True, debugArg = "", deepDebugArg : str = None) -> bool:
+        """
+        Execute a command in the temporary directory\n
+        Default value for deepDebugArg is the same as debugArg
+        """
+        if self.debugLevel == LEVELS.DEBUG:
+            command += debugArg
+        elif self.debugLevel == LEVELS.DEEP_DEBUG:
+            command += deepDebugArg if deepDebugArg is not None else debugArg
         Logger.debug(f'Executing command {command}\n    working directory: {self.tempDir}')
         if hideOutput:
             stdoutFile, stdoutPath = mkstemp()

create-module/src/__init__.py

@@ -1 +1 @@
-from .main import Archive
+from .createModule import Archive

create-module/src/__main__.py

@@ -1,5 +1,5 @@
 import argparse
-from .main import Archive
+from .createModule import Archive
 from .customTypes import Version, ModuleTypes
 from gamuLogger import Logger, error, info, critical, LEVELS
 
@@ -16,6 +16,7 @@ def createParser():
     parser.add_argument("module_type", help="The module type")
     parser.add_argument("module_description", help="The module description")
     parser.add_argument("module_author", help="The module author")
+    parser.add_argument("--outDir", "-o", help="The output directory for the archive", default=".")
     parser.add_argument("--branch", help="The branch of the repository", default="main")
     parser.add_argument("--debug", "-d", help="Enable debug mode", action="store_true")
     return parser
@@ -24,24 +25,26 @@ def createParser():
 
 info("Starting module creation")
 
-try:
-    parser = createParser()
-    args = parser.parse_args()
-    
-    if args.debug:
-        Logger.setLevel("stdout", LEVELS.DEBUG)
 
-    module_version = Version.fromString(args.module_version)
-    module_type = ModuleTypes.fromString(args.module_type)
+parser = createParser()
+args = parser.parse_args()
+
+if args.debug:
+    Logger.setLevel("stdout", LEVELS.DEBUG)
+
+module_version = Version.fromString(args.module_version)
+module_type = ModuleTypes.fromString(args.module_type)
 
-    info(f"Creating archive for module {args.module_name} version {module_version}")
+info(f"Creating archive for module {args.module_name} version {module_version}")
+
+archive = Archive(args.outDir, args.compiled_code_folder, args.module_name, module_version, module_type, args.module_description, args.module_author, args.branch)
 
-    archive = Archive(args.compiled_code_folder, args.module_name, module_version, module_type, args.module_description, args.module_author, args.branch)
+try:
     archive.create()
-
 except Exception as e:
     critical(f"Error creating module: {str(e)}")
     exit(1)
-
-info(f"Archive created: {archive}")
-exit(0)
+else:
+    info(f"Archive created: {archive}")
+    info(f"MD5: {archive.getMD5()}")
+    exit(0)

create-module/src/createModule.py

@@ -0,0 +1,83 @@
+
+from zipfile import ZipFile
+import json
+from datetime import datetime
+import hashlib
+import os
+
+from gamuLogger import Logger
+from .customTypes import Version, ModuleTypes, Step
+
+from .utils import addFolderToZip
+
+class Archive:
+    def __init__(self,
+                 outDir : str,
+                 compiled_code_folder : str,
+                 module_name : str,
+                 module_version : Version,
+                 module_type : ModuleTypes,
+                 module_description : str,
+                 module_author : str,
+                 branch : str = "main"):
+        self.compiled_code_folder = compiled_code_folder
+        self.module_name = module_name
+        self.module_version = module_version
+        self.module_type = module_type
+        self.module_description = module_description
+        self.module_author = module_author
+        self.branch = branch
+        
+        self.archiveName = f'{outDir}/{self.module_name}-{str(self.module_version)}.gamod'
+        
+        self.step = Step.INITIATED
+    
+    def create(self):
+        if self.step != Step.INITIATED:
+            raise ValueError("Archive already created")
+        
+        Logger.info(f"starting creation of archive {self.archiveName}")
+        self.__checkFolderContent()
+        self.zipFile = ZipFile(self.archiveName, 'w')
+        self.__addCode()
+        self.__createJson()
+        Logger.info(f"Archive {self.archiveName} created")
+        self.step = Step.BUILT
+        
+    
+    def getMD5(self):
+        if self.step != Step.BUILT:
+            raise ValueError("Archive not created")
+        md5 = hashlib.md5()
+        with open(self.archiveName, "rb") as f:
+            for chunk in iter(lambda: f.read(4096), b""):
+                md5.update(chunk)
+        return md5.hexdigest()
+    
+    def __checkFolderContent(self):
+        for requiredFile in ["server/main.js", "client/index.html"]:
+            if requiredFile not in os.listdir(self.compiled_code_folder):
+                raise FileNotFoundError(f"File {requiredFile} not found in {self.compiled_code_folder}")
+           
+    def __addCode(self):
+        Logger.debug(f"Adding code from {self.compiled_code_folder} to zip")
+        addFolderToZip(self.zipFile, "build", self.compiled_code_folder)
+    
+    def __createJson(self):
+        Logger.debug(f"Creating json file for module {self.module_name} version {self.module_version}")
+        module = {
+            "name": self.module_name,
+            "version": str(self.module_version),
+            "type": str(self.module_type),
+            "description": self.module_description,
+            "author": self.module_author,
+            "created_at": datetime.now().strftime("%Y-%m-%d %H:%M:%S"),
+            "repository": f"https://github.com/GamuNetwork/{self.module_name}",
+            "branch": self.branch
+        }
+        result = json.dumps(module, indent=4)
+        self.zipFile.writestr('module.json', result)
+        Logger.debug(f"Json file created:\n{result}")
+    
+    def __str__(self):
+        return self.archiveName

create-module/src/customTypes.py

@@ -79,4 +79,9 @@ def fromString(type : str) -> 'ModuleTypes':
         elif type == "interface":
             return ModuleTypes.INTERFACE
         else:
-            return ModuleTypes.OTHER
+            return ModuleTypes.OTHER
+        
+class Step(Enum):
+    INITIATED = 1
+    BUILT = 2
+