Fix remote tracking does not support SSH (#256)

Fixes #244 

So far, only the hands-ons are affected. Exercises are not affected
until Tour 8, where pushing to remote repo is required.
List of updated `hands-ons` are listed in the Incident Review below.

**Solution**:
Implemented method `get_github_git_protocol` to obtain the GitHub
preferred protocol (`https` or `ssh`)
Implemented method `get_remote_url` to get the correct remote url for a
repo.
`get_remote_url` calls `get_github_git_protocol` to check for the
protocol that user is using, before configuring the url accordingly.

for some hands-ons where forking is required, and we push to the forked
repo:
- use `clone_repo_with_gh`
- remove the upstream with `remove_remote("upstream", verbose)`

for hands-on where we have to do `git remote add origin` manually:
- obtain the correct remote url using `get_remote_url` before adding it
manually.

Tested using both `https` and `ssh` protocol, no unexpected behavior so
far.

refer to this [Incident
Review](https://docs.google.com/document/d/1Fw-BgXCHorESJnvw0w2GDfrpn8DyUvg7Q3X9WBJk-KE/edit?tab=t.0#heading=h.puki3yyz9ga3)
for details

---------

Co-authored-by: Vikram Goyal <vikramgoyalsg@gmail.com>

Author: SAN-MUYUN

exercise_utils/github_cli.py

@@ -54,6 +54,15 @@ def get_github_username(verbose: bool) -> str:
     return ""
 
 
+def get_github_git_protocol(verbose: bool) -> str:
+    """returns GitHub CLI's preferred Git transport protocol"""
+    result = run(["gh", "config", "get", "git_protocol"], verbose)
+    if result.is_success():
+        protocol = result.stdout.splitlines()[0].strip()
+        return protocol
+    return ""
+
+
 def has_repo(repo_name: str, is_fork: bool, verbose: bool) -> bool:
     """Returns if the given repository exists under the current user's repositories."""
     command = ["gh", "repo", "view", repo_name]
@@ -107,3 +116,15 @@ def get_fork_name(
         forkname = result.stdout.splitlines()[0]
         return forkname
     return ""
+
+
+def get_remote_url(repository_name: str, verbose: bool) -> str:
+    """Returns a remote repo url based on the configured git protocol"""
+    remote_url = f"https://github.com/{repository_name}.git"
+    preferred_protocol = get_github_git_protocol(verbose)
+
+    if preferred_protocol == "ssh":
+        remote_url = f"git@github.com:{repository_name}.git"
+    
+    return remote_url
+

hands_on/fetch_merge.py

@@ -1,13 +1,18 @@
+from logging import info
 from exercise_utils.cli import run_command
 import os
 
 from exercise_utils.git import clone_repo_with_git
+from exercise_utils.github_cli import get_remote_url
 
 __requires_git__ = True
-__requires_github__ = False
+__requires_github__ = True
 
 
 def download(verbose: bool):
+    ahead_repo = "git-mastery/samplerepo-finances-2"
+    ahead_repo_url = get_remote_url(ahead_repo, verbose)
+
     clone_repo_with_git(
         "https://github.com/git-mastery/samplerepo-finances.git", verbose
     )
@@ -18,7 +23,7 @@ def download(verbose: bool):
             "remote",
             "set-url",
             "origin",
-            "https://github.com/git-mastery/samplerepo-finances-2.git",
+            ahead_repo_url,
         ],
         verbose,
     )

hands_on/force_push.py

@@ -4,6 +4,7 @@
 from exercise_utils.github_cli import (
     clone_repo_with_gh,
     create_repo,
+    get_remote_url,
     get_github_username,
 )
 
@@ -16,14 +17,18 @@
 
 
 def download(verbose: bool):
+    username = get_github_username(verbose)
+    remote_repo = f"{username}/{REPO_NAME}"
+    remote_url = get_remote_url(remote_repo, verbose)
+
     create_repo(REPO_NAME, verbose)
     clone_repo_with_gh(UPSTREAM_REPO, verbose, WORK_DIR)
     os.chdir(WORK_DIR)
     remove_remote("origin", verbose)
 
     add_remote(
         "origin",
-        f"https://github.com/{get_github_username(verbose)}/{REPO_NAME}",
+        remote_url,
         verbose,
     )
     run_command(["git", "push", "-u", "origin", "main"], verbose)

hands_on/populate_remote.py

@@ -5,6 +5,7 @@
 from exercise_utils.github_cli import (
     create_repo,
     delete_repo,
+    get_remote_url,
     get_github_username,
     has_repo,
 )
@@ -60,7 +61,9 @@ def _create_things_repository(verbose: bool):
 
 def _link_repositories(verbose: bool):
     full_repo_name = _get_full_repo_name(verbose)
-    add_remote("origin", f"https://github.com/{full_repo_name}", verbose)
+    remote_url = get_remote_url(full_repo_name, verbose)
+
+    add_remote("origin", remote_url, verbose)
 
 
 def _get_full_repo_name(verbose: bool) -> str:

hands_on/remote_branch_pull.py

@@ -1,8 +1,9 @@
 import os
 
 from exercise_utils.file import append_to_file
-from exercise_utils.git import add, checkout, clone_repo_with_git, commit, push
+from exercise_utils.git import add, checkout, clone_repo_with_git, commit, push, remove_remote
 from exercise_utils.github_cli import (
+    clone_repo_with_gh,
     get_github_username,
     fork_repo,
     has_repo,
@@ -26,10 +27,11 @@ def download(verbose: bool):
         delete_repo(full_repo_name, verbose)
 
     fork_repo(TARGET_REPO, FORK_NAME, verbose, False)
-    clone_repo_with_git(f"https://github.com/{full_repo_name}", verbose, LOCAL_DIR)
+    clone_repo_with_gh(full_repo_name, verbose, LOCAL_DIR)
 
     os.chdir(LOCAL_DIR)
 
+    remove_remote("upstream", verbose)
     checkout("hiring", True, verbose)
     append_to_file("employees.txt", "Receptionist: Pam\n")
     add(["employees.txt"], verbose)

hands_on/remote_branch_push.py

@@ -1,5 +1,7 @@
-from exercise_utils.git import clone_repo_with_git
+import os
+from exercise_utils.git import clone_repo_with_git, remove_remote
 from exercise_utils.github_cli import (
+    clone_repo_with_gh,
     delete_repo,
     fork_repo,
     get_fork_name,
@@ -25,6 +27,8 @@ def download(verbose: bool):
     fork_repo(f"{REPO_OWNER}/{REPO_NAME}", FORK_NAME, verbose, False)
 
     existing_name = get_fork_name(REPO_NAME, REPO_OWNER, username, verbose)
-    clone_repo_with_git(
-        f"https://github.com/{username}/{existing_name}", verbose, REPO_NAME
+    clone_repo_with_gh(
+        f"{username}/{existing_name}", verbose, REPO_NAME
     )
+    os.chdir(REPO_NAME)
+    remove_remote("upstream", verbose)

hands_on/update_remote.py

@@ -5,6 +5,7 @@
 from exercise_utils.git import add, init, commit, add_remote
 from exercise_utils.github_cli import (
     delete_repo,
+    get_remote_url,
     has_repo,
     get_github_username,
     create_repo,
@@ -18,6 +19,8 @@
 
 def download(verbose: bool):
     username = get_github_username(verbose)
+    remote_repo = f"{username}/{REPO_NAME}"
+    remote_url = get_remote_url(remote_repo, verbose)
 
     os.makedirs("things")
     os.chdir("things")
@@ -61,6 +64,6 @@ def download(verbose: bool):
         delete_repo(REPO_NAME, verbose)
 
     create_repo(REPO_NAME, verbose)
-    add_remote("origin", f"https://github.com/{username}/{REPO_NAME}", verbose)
+    add_remote("origin", remote_url, verbose)
 
     run_command(["git", "push", "-u", "origin", "main"], verbose)