scripts: new-problem: create a branch

This change modifies the 'new-problem' script to also create a new branch.
- stash any uncommitted changes
- switch to the master branch
- fetch and pull
- checkout a new branch using the template 'issue/{issue_number}/{problem_name}'

Fixes #288

Signed-off-by: Christopher Friedt <[email protected]>

Author: cfriedt

.github/workflows/ci.yml

@@ -14,6 +14,8 @@ jobs:
 
     env:
       PYTHONPATH: ${{ github.workspace }}/.scripts
+      # ideally there would be a simple way to append / prepend to the path outside of jobs, but no
+      PATH: /home/runner/.local/bin:/home/linuxbrew/.linuxbrew/bin:/home/linuxbrew/.linuxbrew/sbin:/opt/pipx_bin:/usr/share/rust/.cargo/bin:/home/runner/.config/composer/vendor/bin:/home/runner/.dotnet/tools:/snap/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
 
     steps:
 
@@ -22,15 +24,24 @@ jobs:
 
     - name: Setup Python Environment
       run: |
-        sudo apt install -y python3-pytest
+        pip3 install --upgrade pip
+        pip3 install -r .scripts/requirements.txt
 
     - name: Test Python
       run: |
-        pytest-3 .scripts/*_test.py
+        # Both problem.py and problem_test.py assume that the 'master' branch is available
+        # but GitHub Actions only check out 1 ref (e.g. 'pull/289/merge', a GitHub-managed tag).
+        # Here we create the master branch if it does not already exist.
+        if [ "$(git branch --list master)" == "" ]; then
+            REF="$(git rev-parse HEAD)"
+            git fetch origin
+            git checkout -b master origin/master
+            git checkout ${REF}
+        fi
+        pytest .scripts/*_test.py
 
     - name: Setup C++ CEnvironment
       run: |
-        sudo apt-get update
         sudo apt install -y cmake clang clang-tidy gcovr
         sudo sh .scripts/build-and-install-libgtest-libraries.sh
 

.scripts/problem.py

@@ -6,6 +6,7 @@
 
 from datetime import datetime
 import enum
+from git import Repo
 import os
 import re
 import sys
@@ -84,6 +85,7 @@ def __init__(self, args):
 
         # github attributes
         self._issue = args.issue
+        self._branch = 'issue/{}/{}'.format(args.issue, args.name)
 
         # problem attributes
         # self._leetcode_number = -1
@@ -192,6 +194,26 @@ def create_impl_and_test(self):
 
             raise
 
+    def checkout_branch(self, create=True):
+        repo = Repo(os.getcwd())
+        git = repo.git
+
+        try:
+            # stash any uncommitted changes
+            git.add('*')
+            git.stash()
+        except:
+            pass
+
+        git.checkout('master')
+        git.fetch('-p')
+        git.pull()
+
+        if create:
+            git.checkout('-b', self._branch)
+        else:
+            git.checkout(self._branch)
+
 def new_problem():
     args = Problem.default_args()
 
@@ -219,6 +241,7 @@ def new_problem():
         args.problem_template += line
 
     p = Problem(args)
+    p.checkout_branch()
     p.create_impl_and_test()
 
     return p

.scripts/problem_test.py

@@ -4,6 +4,8 @@
 #
 # SPDX-License-Identifier: MIT
 
+import git
+from git import Repo
 import io
 import os
 import requests
@@ -15,7 +17,6 @@
 from problem import Problem
 from problem import Difficulty
 
-
 def test_init_happy_path():
     args = Problem.default_args()
     args.name = '3sum'
@@ -86,6 +87,10 @@ def test_init_invalid_name():
 
 def test_create_problem(monkeypatch):
 
+    repo = Repo(os.getcwd())
+    assert(repo.bare == False)
+    git = repo.git
+
     solution = \
         '''class Solution {
 public:
@@ -99,12 +104,18 @@ def test_create_problem(monkeypatch):
     my_stdin = 'TEST-foo-bar\n42\n3\n' + solution
     my_stdout = ''
 
+    try:
+        git.branch('-D', 'issue/42/TEST-foo-bar')
+    except:
+        pass
+
     monkeypatch.setattr('sys.stdin', io.StringIO(my_stdin))
     p = problem.new_problem()
 
     assert(p._name == 'TEST-foo-bar')
     assert(p._camel == 'TESTFooBar')
     assert(p._issue == 42)
+    assert(p._branch == 'issue/42/TEST-foo-bar')
     assert(p._difficulty == Difficulty.HARD)
     assert(p._problem_template + '\n' == solution)
 
@@ -119,9 +130,15 @@ def test_create_problem(monkeypatch):
     if not os.path.exists(test_cpp):
         io_fail = True
 
+    git.checkout('master')
+    git.branch('-D', p._branch)
+
     if io_fail:
         try:
             os.remove(impl_cpp)
+        except:
+            pass
+        try:
             os.remove(test_cpp)
         except:
             pass
@@ -148,3 +165,29 @@ def test_create_problem(monkeypatch):
     assert(p._space == -1)
     assert(p._space_rank == -1)
     assert(p._space_complexity == '')
+
+
+def test_checkout_branch():
+
+    repo = Repo(os.getcwd())
+    assert(repo.bare == False)
+    git = repo.git
+
+    git.checkout('master')
+    assert('master' == '{}'.format(repo.active_branch))
+
+    args = Problem.default_args()
+    args.issue = 123
+    args.name = 'foo-bar'
+    p = Problem(args)
+
+    p.checkout_branch()
+    branch_name = repo.active_branch
+
+    git.checkout('master')
+    try:
+        git.branch('-D', branch_name)
+    except:
+        pass
+
+    assert('{}'.format(branch_name) == 'issue/{}/{}'.format(args.issue, args.name))

.scripts/requirements.txt

@@ -0,0 +1,3 @@
+pytest
+gitpython
+