Working on improved argument system for script suite

Author: JRProd

Build.py

@@ -1,39 +1,86 @@
+import argparse
+
 from Scripts.UpdateVersionNumber import update_version_number
 from Scripts.UpdateFromP4 import update_from_P4
 from Scripts.BuildLighting import build_lighting
 from Scripts.BuildGame import build_game
 from Scripts.UploadToDeletedNighly import upload_to_deleted_nightly
 from Scripts.UploadToSteam import upload_to_steam
 
+from Scripts import Environment as env
+
+# Create and setup the argument parser for the user scripts
+parser = argparse.ArgumentParser(description='Python based UE4 Versioning, Building, Packaging, and Uploading suite')
+parser.add_argument('-m', '--minor', action='store_true', default=False, help='Increment the minor version of the project. Will be overriden by the major argument')
+parser.add_argument('-M', '--major', action='store_true', default=False, help='Increment the major version of the project. Will override the minor argument')
+parser.add_argument('-n', '--no-lighting', action='store_true', default=False, help='Skip the lighting build')
+parser.add_argument('-a', '--all', action='store_true', default=False, help='Run the full script suite. This is purely for verbosity. Giving no individual script arguments has the same effect')
+parser.add_argument('-p4', '--perforce', action='store_true', default=False, help='Update from P4V')
+parser.add_argument('-uv', '--version', action='store_true', default=False, help='Update the version number')
+parser.add_argument('-bl', '--lighting', action='store_true', default=False, help='Build the lighting')
+parser.add_argument('-bg', '--build', action='store_true', default=False, help='Build the game')
+parser.add_argument('-us', '--steam', action='store_true', default=False, help='Upload to steam')
+parser.add_argument('--output', action='store', nargs='?', default='log.txt', help='Set the output files name that is generated in the environments build location')
+
+def script_error( log_file, error_message ):
+    log_file.write("ERROR: " + error_message)
+    log_file.close()
+    quit(1)
 
 if __name__ == '__main__':
-    print( '++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++')
-    print( 'Initiating Build Sequence ')
-
-    success = update_from_P4()
-    if success:
-        success = update_version_number( False, False, True)
-        pass
-    else:
-        print("[FAILED] Failed to update from perforce")
-
-    if success:
-        success = build_lighting()
-        pass
-    else:
-        print("[FAILED]: Failed to update version number")
-
-    if success:
-        success = build_game()
-        pass
-    else:
-        print("[FAILED]: Failed to build lighting")
-
-    if success:
-        success = upload_to_steam()
-        pass
-    else:
-        print("[FAILEd]: Failed to build and package the game")
+    args = parser.parse_args()
+
+    build_dir = env.get_env_variable('Game', 'builds_dir')
+    log_file = open( build_dir + args.output, 'w')
+
+    log_file.write( '++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++\n' )
+    log_file.write( 'Initiating Build Sequence\n' )
+
+    # If no commands are give, assume the user wants to run the full suite of scripts
+    args.all = True if not (args.perforce or args.version or args.lighting or args.build or args.steam) else args.all
+
+    # Defines the success of the previous operation
+    success = True
+    if args.all or args.perforce:
+        success = update_from_P4(log_file)
+    if not success:
+        script_error(log_file, 'Failed to update from P4V')
 
+    if success and (args.all or args.version):
+        success = update_version_number( log_file, args.major, args.minor)
     if not success:
-        print("[FAILED]: Failed to upload to steam")
+        script_error(log_file, 'Failed to update the version number')
+
+    if success and not args.no_lighting and (args.all or args.lighting):
+        success = build_lighting( log_file )
+
+
+    # success = update_from_P4()
+    # if success:
+    #     success = update_version_number( major, minor, hotfix)
+    #     pass
+    # else:
+    #     print('[FAILED] Failed to update from perforce')
+
+    # if success:
+    #     success = build_lighting()
+    #     pass
+    # else:
+    #     print('[FAILED]: Failed to update version number')
+
+    # if success:
+    #     success = build_game()
+    #     pass
+    # else:
+    #     print('[FAILED]: Failed to build lighting')
+
+    # if success:
+    #     success = upload_to_steam()
+    #     pass
+    # else:
+    #     print('[FAILEd]: Failed to build and package the game')
+
+    # if not success:
+    #     print('[FAILED]: Failed to upload to steam')
+
+    log_file.close()

Scripts/BuildLighting.py

@@ -7,23 +7,27 @@
 
 game_name = env.get_env_variable('Game','game_name')
 
-def build_lighting():
-    print( '----------------------------------------------------------------------------------------------------' )
-    print( '{} - Step 3: Starting Lighting Build'.format( game_name ) )
-    print( '----------------------------------------------------------------------------------------------------' )
+def build_lighting( log_file ):
+    log_file.write( '----------------------------------------------------------------------------------------------------\n' )
+    log_file.write( '{} - Step 3: Starting Lighting Build\n'.format( game_name ) )
+    log_file.write( '----------------------------------------------------------------------------------------------------\n' )
 
     maps = []
 
     # Compile the list of maps
     map_dir = env.get_env_variable('Game', 'map_dir')
     map_names = env.get_env_variable('Game', 'maps').split(';')
 
+    log_file.write('Building lighting for these maps: ')
     for map in map_names:
+        log_file.write(map + " ")
         full_path_map = map_dir + map
         maps.append( full_path_map + '.umap')
 
         maps.append( full_path_map + '_BuiltData.uasset')
 
+    log_file.write('\n')
+    log_file.flush()
 
      # Check the file out from P4
     p4 = P4()
@@ -44,27 +48,32 @@ def build_lighting():
         # Build the lighting
         uproject_file = env.get_env_variable( "Game", "uproject_file" )
         ue4_binaries_dir = env.get_env_variable( 'Local', "ue4_binaries_dir" )
-        print(subprocess.run( [ ue4_binaries_dir + 'UE4Editor-Cmd.exe', uproject_file, '-verbose', "-p4", "-submit", "-run=resavepackages" , "-buildlighting", "-quality=production", "-allowcommandletrendering", "-map" + ' '.join(maps)] ) )
+        subprocess.run( [ ue4_binaries_dir + 'UE4Editor-Cmd.exe', uproject_file, '-verbose', "-p4", "-submit", "-run=resavepackages" , "-buildlighting", "-quality=production", "-allowcommandletrendering", "-map" + ' '.join(maps)], stdout=log_file )
+        log_file.flush()
 
         # Add maps back for addition to p4
         for map in maps:
-            print("adding " + map)
+            log_file.write("adding " + map + '\n')
             p4.run('add', map)
+        log_file.flush()
 
         change = p4.fetch_change()
         change._description = '[Daily_Builds] Built lighting for the follow maps:\n' + '\n\t'.join(maps)
-        p4.run_submit( change ) 
+        # p4.run_submit( change ) 
+
+        log_file.write('Lighting successfully built and submitted\n')
+        log_file.flush()
 
         return True
     except P4Exception:
-        print('ERROR: Error capture in P4')
+        log_file.write('Perforce error encountered')
         for e in p4.errors:
-            print(e)
+            log_file.write( str(e) )
+
+        log_file.flush()
 
         return False
     except Exception as e:
-        print(e)
+        log_file.write( str(e) )
+        log_file.flush()
         return False
-
-if __name__ == '__main__':
-    build_lighting()

Scripts/UpdateFromP4.py

@@ -39,10 +39,11 @@ def run(self):
 
 game_name = env.get_env_variable('Game', 'game_name')
 
-def update_from_P4():
-    print( '----------------------------------------------------------------------------------------------------' )
-    print( '{} - Step 1: Update the local workspace for P4'.format( game_name ) )
-    print( '----------------------------------------------------------------------------------------------------' )
+def update_from_P4( log_file ):
+    log_file.write( '----------------------------------------------------------------------------------------------------\n' )
+    log_file.write( '{} - Step 1: Update the local workspace for P4\n'.format( game_name ) )
+    log_file.write( '----------------------------------------------------------------------------------------------------\n' )
+    log_file.flush()
 
     # Perforce Settings
     p4.port = "129.119.63.244:1666"
@@ -52,16 +53,19 @@ def update_from_P4():
 
     # Connect to the perforce server
     success = p4.connect()
-    print( success )
+    log_file.write( str(success) )
+    log_file.write('\n')
+    log_file.flush()
 
     p4_thread = Threaded_Callback(1, p4_sync, p4_sync_callback)
     p4_thread.start()
 
     start_time = time.time()
     while( not files_synced ):
-        print( "Time Elapsed: {:.2f}".format( time.time() - start_time ), end='\r')
+        pass
 
-    print( 'Completed Perfoce Sync in {:.2f} seconds'.format( time.time() - start_time ) )
+    log_file.write( 'Completed Perfoce Sync in {:.2f} seconds\n'.format( time.time() - start_time ) )
+    log_file.flush()
 
     files_updated = 0
     files_deleted = 0
@@ -84,15 +88,16 @@ def update_from_P4():
         update_message += file['rev'] + " ) - "
         update_message += file['action']
 
-        print(update_message)
+        log_file.write(update_message)
+        log_file.write('\n')
+
+        if files_updated % 100 == 0:
+            log_file.flush()
 
     if files_deleted > 0:
-        print( '{} files marked for deleted in total'.format( files_deleted ) )
+        log_file.write( '{} files marked for deleted in total\n'.format( files_deleted ) )
     if files_updated == 0:
-        print( 'All files are current' )
+        log_file.write( 'All files are current\n' )
+    log_file.flush()
 
     return True
-
-if __name__ == '__main__':
-    update_from_P4()
-    

Scripts/UpdateVersionNumber.py

@@ -8,27 +8,29 @@
 
 game_name = env.get_env_variable('Game','game_name')
 
-def update_version_number( major, minor, hotfix ):
-    print( '----------------------------------------------------------------------------------------------------' )
-    print( '{} - Step 2: Update the version number'.format( game_name ) )
-    print( '----------------------------------------------------------------------------------------------------' )
+def update_version_number( log_file, major, minor ):
+    log_file.write( '----------------------------------------------------------------------------------------------------\n' )
+    log_file.write( '{} - Step 2: Update the version number\n'.format( game_name ) )
+    log_file.write( '----------------------------------------------------------------------------------------------------\n' )
 
+    # Determine if automatic versioning is used by the config file
     try:
         automatic_versioning = env.get_env_variable('Version', 'automatic')
 
     # If no versioning disinction continue
     except Exception as e:
-        print('Automatic versioning system skipped because no [Version] automatic value found')
+        log_file.write('Automatic versioning system skipped because no [Version] automatic value found\n')
         return True
 
     if 'False' in automatic_versioning:
-        print('Automatic versioning system skipped because its disabled')
+        log_file.write('Automatic versioning system is disabled\n')
         return True
     elif not 'True' in automatic_versioning:
-        print('Unknown value {} in [Version] automatic. Expected "True"/"False" values')
+        log_file.write("Unknown value {} in [Version] automatic. Expected 'True'/'False' values\n".format(automatic_versioning) )
         return False
+    log_file.flush()
 
-    version_number = ""
+    version_number = ''
 
     # Open ini file
     version_ini = env.get_env_variable('Version', 'version_ini')
@@ -53,10 +55,13 @@ def update_version_number( major, minor, hotfix ):
             found_version = True
 
     if not found_version:
-        print("Failed to find version number")
+        log_file.write('Failed to find version number\n')
+        return False
 
     # Update the version number
-    new_version = get_version_number(major, minor, hotfix, version_number)
+    new_version = get_version_number(major, minor, version_number)
+    log_file.write('Version number updated to {}\n'.format(new_version))
+    log_file.flush()
 
     # Check the file out from P4
     p4 = P4()
@@ -85,19 +90,25 @@ def update_version_number( major, minor, hotfix ):
 
         change = p4.fetch_change()
         change._description = '[Daily_Builds] Updated the version number to ' + new_version
-        p4.run_submit( change ) 
+        # p4.run_submit( change )
+
+        log_file.write('New version number successfully submitted to perforce\n')
+        log_file.flush()
 
         return True
     except P4Exception:
+        log_file.write('Perforce error encountered')
         for e in p4.errors:
-            print(e)
+            log_file.write( str(e) )
 
+        log_file.flush()
         return False
     except Exception as e:
-        print(e)
+        log_file.write( str(e) )
+        log_file.flush()
         return False
 
-def get_version_number(major, minor, hotfix, version):
+def get_version_number(major, minor, version):
     split_version = version.split('.')
     if major:
         split_version[0] = str(int(split_version[0]) + 1)
@@ -110,10 +121,7 @@ def get_version_number(major, minor, hotfix, version):
         split_version[2] = '0'
         return '.'.join(split_version)
 
-    if hotfix:
-        split_version[2] = str(int(split_version[2]) + 1)
-        return '.'.join(split_version)
- 
-
-if __name__ == '__main__':
-    update_version_number(False, False, True)
+    # If not major or minor, must be hotfix
+    split_version[2] = str(int(split_version[2]) + 1)
+    return '.'.join(split_version)
+