README and small corrections for Gitea/GitLab scripts

Author: shurup

2021/09-gitea-gitlab-migration/README.md

@@ -0,0 +1,5 @@
+Here are Python scripts that can be used when migrating from Gitea to GitLab.
+
+This repo is intended to be used as a playground for a corresponding article:
+
+* Russian version: «[Опыт миграции из Gitea в GitLab. Сложно, но успешно](https://habr.com/ru/company/flant/blog/577808/)».

2021/09-gitea-gitlab-migration/add_collaborator.py

@@ -9,7 +9,7 @@
 import random
 import string
 
-# gitea connection
+# Gitea connection
 configuration = giteapy.Configuration()
 configuration.api_key['access_token'] = 'superSecret'
 configuration.host = 'https://gitea.example.com/api/v1'
@@ -18,7 +18,7 @@
 org_api_instance = giteapy.OrganizationApi(giteapy.ApiClient(configuration))
 repo_api_instance = giteapy.RepositoryApi(giteapy.ApiClient(configuration))
 
-# Adding RO user for migrations in any repo
+# adding RO user for migrations in any repo
 all_orgs = admin_api_instance.admin_get_all_orgs()
 for org in all_orgs:
     print(org.username)

2021/09-gitea-gitlab-migration/gitea_gitlab_import_repo.py

@@ -15,14 +15,14 @@
 driver = webdriver.Firefox(os.getcwd()+os.path.sep)
 driver.get(GITLAB_URL)
 
-# Gitlab login
+# GitLab login
 user = driver.find_element_by_id("user_login")
 user.send_keys(GITLAB_USER)
 pas = driver.find_element_by_id("user_password")
 pas.send_keys(GITLAB_PASSWORD)
 login = driver.find_element_by_name("commit").click()
 
-# Starting import process
+# starting import process
 driver.get(GITLAB_URL+"/import/gitea/new")
 gitea_host = driver.find_element_by_name("gitea_host_url")
 gitea_host.send_keys(GITED_URL)
@@ -38,15 +38,15 @@
   # clicking select button to show dropdown menu and activate buttons
   row.find_element_by_class_name("gl-dropdown-toggle").click()
   time.sleep(1)
-  # Finding project group
+  # finding project group
   for btn in row.find_elements_by_class_name("dropdown-item"):
     if btn.get_attribute("data-qa-group-name") == group:
       btn.click()
   time.sleep(1)
   # starting import
   import_button = row.find_element(By.XPATH, "//button[@data-qa-selector='import_button']")
   import_button.click()
-  # Wait until import is ready
+  # wait until import is ready
   while True:
     time.sleep(10)
     status = row.find_elements_by_class_name("gl-p-4")[-1].text

2021/09-gitea-gitlab-migration/gitea_gitlab_user_copier.py

@@ -16,20 +16,20 @@ def get_random_string(length):
     result_str = ''.join(random.choice(letters) for i in range(length))
     return result_str
 
-# gitea connection
+# Gitea connection
 configuration = giteapy.Configuration()
 configuration.api_key['access_token'] = 'superSecret'
 configuration.host = 'https://gitea.example.com/api/v1'
 admin_api_instance = giteapy.AdminApi(giteapy.ApiClient(configuration))
 user_api_instance = giteapy.UserApi(giteapy.ApiClient(configuration))
 org_api_instance = giteapy.OrganizationApi(giteapy.ApiClient(configuration))
 
-# gitlab connection
+# GitLab connection
 gl = gitlab.Gitlab('https://gitlab.example.com', private_token='superSecret')
 
-# inspect gitlab
+# inspect GitLab
 dict_gl_users = dict()
-# get gitea users
+# get Gitea users
 gt_users = admin_api_instance.admin_get_all_users()
 #pprint(api_response)
 lg_gt_map = dict()

2021/09-gitea-gitlab-migration/gitlab_fix_keys.py

@@ -23,27 +23,27 @@ def get_random_string(length):
 def get_hash(key):
     return hashlib.md5(key.encode('utf-8')).hexdigest()
 
-# gitea connection
+# Gitea connection
 configuration = giteapy.Configuration()
 configuration.api_key['access_token'] = 'superSecret'
 configuration.host = 'https://gitea.example.com/api/v1'
 admin_api_instance = giteapy.AdminApi(giteapy.ApiClient(configuration))
 user_api_instance = giteapy.UserApi(giteapy.ApiClient(configuration))
 org_api_instance = giteapy.OrganizationApi(giteapy.ApiClient(configuration))
 
-# gitlab connection
+# GitLab connection
 gl = gitlab.Gitlab('https://gitlab.example.com', private_token='superSecret')
 
 # clean blocked users keys
 for block_gl_user in gl.users.list(blocked=True, page=1, per_page=10000):
     print("Blocked user", block_gl_user.username)
     for block_gl_user_key in block_gl_user.keys.list():
-        print("Found key", block_gl_user_key.title)
+        print("Found a key", block_gl_user_key.title)
         block_gl_user_key.delete()
 
-# inspect gitlab
+# inspect GitLab
 dict_gl_users = dict()
-# get gitea users
+# get Gitea users
 gt_users = admin_api_instance.admin_get_all_users()
 pattern = re.compile("^id_.+$")
 
@@ -61,7 +61,7 @@ def get_hash(key):
     res = gl.users.list(username=gt_user.login)
     if len(res) > 0:
         if res[0].attributes['state'] == 'blocked':
-            print("Skip blocked user", gt_user.login)
+            print("Skip the blocked user", gt_user.login)
             continue
         dict_gl_users[res[0].username] = res[0]
         gl_keys_dict = dict()
@@ -72,7 +72,7 @@ def get_hash(key):
         keys_to_delete = list()
         for raw_gl_key in gl_keys:
             if pattern.match(raw_gl_key.title):
-                print(gt_user.login, "delete key", raw_gl_key.title)
+                print(gt_user.login, "delete the key", raw_gl_key.title)
                 raw_gl_key.delete()
             else:
                 gl_key_hash = get_hash(raw_gl_key.key.strip().split(' ')[1])
@@ -86,23 +86,23 @@ def get_hash(key):
             if gt_key in gl_keys_dict:
                 keys_to_delete.remove(gt_key)
             else:
-                print(gt_user.login, "missing key", gt_keys_dict[gt_key].title)
+                print(gt_user.login, "missing a key", gt_keys_dict[gt_key].title)
                 try:
                     res[0].keys.create({'title': gt_keys_dict[gt_key].title, 'key': gt_keys_dict[gt_key].key})
                     res[0].save()
                 except:
                     all_problem_keys_dict.append(gt_key)
-                    print(gt_user.login, "can not add key", gt_keys_dict[gt_key].title)
+                    print(gt_user.login, "can not add the key", gt_keys_dict[gt_key].title)
         for dkey in keys_to_delete:
             if pattern.match(gl_keys_dict[dkey].title):
-                print(gt_user.login, "has additional key", gl_keys_dict[dkey].title)
+                print(gt_user.login, "has an additional key", gl_keys_dict[dkey].title)
                 #gl_keys_dict[key].delete()
     else:
         print("New user", gt_user.login)
 
-print("Get problems key", len(all_problem_keys_dict))
+print("Get problematic key", len(all_problem_keys_dict))
 for pkey in all_problem_keys_dict:
     if pkey in all_gl_keys_dict:
-        print("Key", pkey, "has user", all_gl_keys_dict[pkey])
+        print("This key", pkey, "has user", all_gl_keys_dict[pkey])
     else:
         print("Can not find user for key", pkey)

2021/09-gitea-gitlab-migration/gitlab_fix_refs.py

@@ -8,12 +8,12 @@
 import subprocess
 import shutil
 
-# gitlab connection
+# GitLab connection
 gl = gitlab.Gitlab('https://gitlab.example.com', private_token='superSecret')
 
 shutil.rmtree('code',ignore_errors=True)
 
-# Adding empty commit everywhere
+# adding an empty commit everywhere
 all_orgs = gl.groups.list()
 skip_orgs = ['someorg']
 for org in all_orgs: