Merge branch 'develop'

Author: WtfJoke

README.md

@@ -1,11 +1,11 @@
 # rtc2git
-A tool made for migrating code from an existing RTC SCM repository into a Git repository
-It uses the CLI of RTC to gather the required informations
+A tool made for migrating code from an existing [RTC] (https://jazz.net/products/rational-team-concert/) SCM repository into a Git repository
+It uses the CLI of RTC to gather the required informations (You can find the CLI under the name "SCM Tools" [here] (https://jazz.net/downloads/rational-team-concert/releases/5.0.1?p=allDownloads))
 
 ## Prerequirements
 <ul>
 <li> RTC Version 5.0+ (Was tested using 5.0.1) </li> 
-<li> Working RTC CLI aka "SCM Tools"  --> (e.g Command "lscm help" should work in console) </li>
+<li> RTC CLI --> (e.g Command "lscm help" should work in console) </li>
 <li> Python 3 </li>
 </ul>
 
@@ -26,3 +26,6 @@ It uses the CLI of RTC to gather the required informations
 <li>The corresponding git command will be executed to do the same change in the git-repository</li>
 </ol>
 
+
+## Wiki
+For more details [visit our wiki] (https://github.com/WtfJoke/rtc2git/wiki)

config.ini.sample

@@ -2,15 +2,21 @@
 Repo=https://rtc.mySite.com
 User=USR
 Password=secret
-Stream=HeadDevelopmentStream
 GIT-Reponame = myGitRepo.git
 WorkspaceName=ToBeCreatedWorkspaceName
 ## Will be created or emptied on initialization
 Directory = \temp\myWorkingDirectory
 
 [Migration]
-# Streams referenced by Name or UUID, separated by ",".
-# They should follow the order the way you like your branches, beginning from the oldest and ending with your most current stream
-Streams=Stream_Version1, Stream_Version2, HeadDevelopmentStream
+# Streams to be migrated,  referenced by Name or UUID, separated by ",".
+# This can be either multiple streams or just one stream
+StreamsToMigrate = Stream_Version1, Stream_Version2, HeadDevelopmentStream
 
+# Earliest/Oldest Stream, where the migration should start
+# Referenced by Name or UUID
+OldestStream = Stream_Version1
 
+# Optional, can be defined additionally to set the workspace to a earlier specific baseline
+# (baseline which were created earlier than the baselines of the oldest stream)
+# Use following format: ComponentName = BaseLineName, AnotherComponentName=BaseLineName
+InitialBaseLines =

configuration.py

@@ -1,6 +1,7 @@
 import os
 import configparser
 
+from rtcFunctions import ComponentBaseLineEntry
 import shell
 import shouter
 
@@ -13,23 +14,25 @@ def readconfig():
     password = generalsection['Password']
     workspace = generalsection['WorkspaceName']
     repositoryurl = generalsection['Repo']
-    mainstream = generalsection['Stream']
     workdirectory = generalsection['Directory']
     if not workdirectory:
         workdirectory = "."
     migrationsection = config['Migration']
-    streamsfromconfig = migrationsection['Streams']
+    oldeststream = migrationsection['OldestStream']
+    streamsfromconfig = migrationsection['StreamsToMigrate']
     streamnames = getstreamnames(streamsfromconfig)
     initialcomponentbaselines = []
-    definedbaselines = ""  # migrationsection['InitialBaseLine']
-    # if definedbaselines:
-    #     componentbaselines = definedbaselines.split(",")
-    #     for entry in componentbaselines:
-    #         componentbaseline = entry.split("=")
-    #         component = componentbaseline[0].strip()
-    #         baseline = componentbaseline[1].strip()
+    definedbaselines = migrationsection['InitialBaseLines']
+    if definedbaselines:
+        componentbaselines = definedbaselines.split(",")
+        for entry in componentbaselines:
+            componentbaseline = entry.split("=")
+            component = componentbaseline[0].strip()
+            baseline = componentbaseline[1].strip()
+            initialcomponentbaselines.append(ComponentBaseLineEntry(component, baseline, component, baseline))
     gitreponame = generalsection['GIT-Reponame']
-    return ConfigObject(user, password, repositoryurl, workspace, workdirectory, mainstream, streamnames, gitreponame)
+    return ConfigObject(user, password, repositoryurl, workspace, workdirectory, initialcomponentbaselines, streamnames,
+                        gitreponame, oldeststream)
 
 
 def getstreamnames(streamsfromconfig):
@@ -41,22 +44,27 @@ def getstreamnames(streamsfromconfig):
 
 
 class ConfigObject:
-    def __init__(self, user, password, repo, workspace, workdirectory, mainstream, streamnames, gitreponame):
+    def __init__(self, user, password, repo, workspace, workdirectory, initialcomponentbaselines, streamnames,
+                 gitreponame, oldeststream):
         self.user = user
         self.password = password
         self.repo = repo
         self.workspace = workspace
         self.workDirectory = workdirectory
-        self.mainStream = mainstream
+        self.initialcomponentbaselines = initialcomponentbaselines
         self.streamnames = streamnames
-        self.earlieststreamname = streamnames[0]
+        self.earlieststreamname = oldeststream
         self.gitRepoName = gitreponame
         self.clonedGitRepoName = gitreponame[:-4]  # cut .git
-        self.logFolder = os.getcwd()
+        self.logFolder = os.getcwd() + os.sep + "Logs"
+        self.hasCreatedLogFolder = os.path.exists(self.logFolder)
         self.streamuuids = []
 
     def getlogpath(self, filename):
-        return "%s\%s" % (self.logFolder, filename)
+        if not self.hasCreatedLogFolder:
+            os.makedirs(self.logFolder)
+            self.hasCreatedLogFolder = True
+        return self.logFolder + os.sep + filename
 
     def collectstreamuuids(self):
         shouter.shout("Get UUID's of configured streamnames")

gitFunctions.py

@@ -43,6 +43,7 @@ class Commiter:
     @staticmethod
     def addandcommit(changeentry):
         comment = Commiter.replacegitcreatingfilesymbol(changeentry.comment)
+        Commiter.replaceauthor(changeentry.author, changeentry.email)
         shell.execute("git add -A")
         shell.execute("git commit -m %s --date %s --author=%s"
                       % (shell.quote(comment), shell.quote(changeentry.date), changeentry.getgitauthor()))
@@ -64,6 +65,11 @@ def replacewords(replacedwith, word, *replacingstrings):
                 word = word.replace(replacingstring, replacedwith)
         return word
 
+    @staticmethod
+    def replaceauthor(author, email):
+        shell.execute("git config --replace-all user.name " + shell.quote(author))
+        shell.execute("git config --replace-all user.email " + email)
+
     @staticmethod
     def branch(branchname):
         branchexist = shell.execute("git show-ref --verify --quiet refs/heads/" + branchname)

migration.py

@@ -2,45 +2,56 @@
 import shutil
 
 from rtcFunctions import ImportHandler
+from rtcFunctions import WorkspaceHandler
+from rtcFunctions import RTCInitializer
 from gitFunctions import Initializer
 from gitFunctions import Commiter
 import configuration
 import shouter
 
 
-def initialize(directory):
+def initialize(config):
+    directory = config.workDirectory
     if os.path.exists(directory):
         shutil.rmtree(directory)
     os.mkdir(directory)
     os.chdir(directory)
-    gitInitializer.initalize()
-    rtc.initialize()
-    gitInitializer.initialcommitandpush()
+    git = Initializer(config)
+    git.initalize()
+    RTCInitializer.initialize(config)
+    git.initialcommitandpush()
 
 
-def resume(directory):
-    os.chdir(directory)
-    os.chdir(gitInitializer.clonedRepoName)
-    rtc.loginandcollectstreams()
+def resume(config):
+    os.chdir(config.workDirectory)
+    os.chdir(config.clonedGitRepoName)
+    RTCInitializer.loginandcollectstreams(config)
 
 
 def startmigration():
-    initialize(config.workDirectory)
+    config = configuration.readconfig()
+    rtc = ImportHandler(config)
+    rtcworkspace = WorkspaceHandler(config)
+    git = Commiter
+
+    initialize(config)
     streamuuids = config.streamuuids
     for streamuuid in streamuuids:
         streamname = config.streamnames[streamuuids.index(streamuuid)]
         git.branch(streamname)
         componentbaselineentries = rtc.getcomponentbaselineentriesfromstream(streamuuid)
-        rtc.acceptchangesintoworkspace(rtc.getchangeentriesofstream(componentbaselineentries))
-        shouter.shout("All changes of stream '%s' accepted" % streamname)
+        rtc.acceptchangesintoworkspace(rtc.getchangeentriesofstreamcomponents(componentbaselineentries))
+        shouter.shout("All changes of components of stream '%s' accepted" % streamname)
+        git.pushbranch(streamname)
+
+        rtcworkspace.setcomponentstobaseline(componentbaselineentries, streamuuid)
+        rtcworkspace.load()
+        rtc.acceptchangesintoworkspace(rtc.getchangeentriesofstream(streamuuid))
         git.pushbranch(streamname)
-        rtc.recreateworkspace(streamuuid)
-        rtc.resetcomponentstobaseline(componentbaselineentries, streamuuid)
-        rtc.reloadworkspace()
+        shouter.shout("All changes of stream '%s' accepted - Migration of stream completed" % streamname)
 
+        morestreamstomigrate = streamuuids.index(streamuuid) + 1 is not len(streamuuids)
+        if morestreamstomigrate:
+            rtcworkspace.recreateoldestworkspace()
 
-config = configuration.readconfig()
-rtc = ImportHandler(config)
-gitInitializer = Initializer(config)
-git = Commiter()
 startmigration()