self CR + tests

gal432 · gal432 · commit c179eae66f40 · 2021-10-03T17:50:42.000+03:00
diff --git a/lms/lmsweb/config.py.example b/lms/lmsweb/config.py.example
@@ -67,4 +67,8 @@ LIMITS_PER_HOUR = 50
 # Change password settings
 MAX_INVALID_PASSWORD_TRIES = 5
 
-REPOSITORY_FOLDER = os.getenv("REPOSITORY_FOLDER", os.path.abspath(os.path.join(os.curdir, "repositories")))
+_REPOSITORY_FOLDER = os.getenv("REPOSITORY_FOLDER", os.path.abspath(os.path.join(os.curdir, "repositories")))
+
+
+def get_repository_folder():
+    return _REPOSITORY_FOLDER
diff --git a/lms/lmsweb/git_service.py b/lms/lmsweb/git_service.py
@@ -45,43 +45,16 @@ def repository_folder(self) -> str:
 
     def handle_operation(self) -> flask.Response:
         git_operation = self._extract_git_operation()
+        git_repository_folder = os.path.join(self.repository_folder, 'config')
 
-        git_repository_folder = os.path.join(self.repository_folder, '.git')
         first_time_repository = not os.path.exists(git_repository_folder)
         if first_time_repository:
-            os.makedirs(self.repository_folder, exist_ok=True)
-            proc = subprocess.Popen(  # noqa: S603
-                args=['git', 'init', '--bare'],
-                stdin=subprocess.PIPE,
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
-                cwd=self.repository_folder,
-            )
-            if proc.wait() != 0:
-                _logger.error(
-                    'Failed to execute command. stdout=%s\nstderr=%s',
-                    proc.stdout.read(), proc.stderr.read(),
-                )
-                raise EnvironmentError
+            self._initialize_bare_repository()
 
         if not git_operation.supported:
             raise EnvironmentError
 
-        proc = subprocess.Popen(  # noqa: S603
-            args=git_operation.service_command,
-            stdin=subprocess.PIPE,
-            stdout=subprocess.PIPE,
-            stderr=subprocess.PIPE,
-            cwd=self._base_repository_folder,
-        )
-        data_out, _ = proc.communicate(self._request.data, 20)
-
-        if proc.wait() != 0:
-            _logger.error(
-                'Failed to execute command. stdout=%s\nstderr=%s',
-                proc.stdout.read(), proc.stderr.read(),
-            )
-            raise EnvironmentError
+        data_out = self._execute_git_operation(git_operation)
 
         if git_operation.format_response:
             data_out = git_operation.format_response(data_out)
@@ -99,13 +72,45 @@ def handle_operation(self) -> flask.Response:
         res = self.build_response(data_out, git_operation)
         return res
 
+    def _execute_git_operation(self, git_operation: _GitOperation) -> bytes:
+        proc = subprocess.Popen(  # noqa: S603
+            args=git_operation.service_command,
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self._base_repository_folder,
+        )
+        data_out, _ = proc.communicate(self._request.data, 20)
+        if proc.wait() != 0:
+            _logger.error(
+                'Failed to execute command. stdout=%s\nstderr=%s',
+                proc.stdout.read(), proc.stderr.read(),
+            )
+            raise EnvironmentError
+        return data_out
+
+    def _initialize_bare_repository(self):
+        os.makedirs(self.repository_folder, exist_ok=True)
+        proc = subprocess.Popen(  # noqa: S603
+            args=['git', 'init', '--bare'],
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self.repository_folder,
+        )
+        if proc.wait() != 0:
+            _logger.error(
+                'Failed to execute command. stdout=%s\nstderr=%s',
+                proc.stdout.read(), proc.stderr.read(),
+            )
+            raise EnvironmentError
+
     @staticmethod
     def build_response(
             data_out: bytes,
             git_operation: _GitOperation,
     ) -> flask.Response:
         res = flask.make_response(data_out)
-        res.headers['Expires'] = 'Fri, 01 Jan 1980 00:00:00 GMT'
         res.headers['Pragma'] = 'no-cache'
         res.headers['Cache-Control'] = 'no-cache, max-age=0, must-revalidate'
         res.headers['Content-Type'] = git_operation.response_content_type
diff --git a/lms/lmsweb/views.py b/lms/lmsweb/views.py
@@ -24,7 +24,7 @@
 )
 from lms.lmsweb.config import (
     CONFIRMATION_TIME, LANGUAGES, LIMITS_PER_HOUR,
-    LIMITS_PER_MINUTE, LOCALE, MAX_UPLOAD_SIZE, REPOSITORY_FOLDER,
+    LIMITS_PER_MINUTE, LOCALE, MAX_UPLOAD_SIZE, get_repository_folder,
 )
 from lms.lmsweb.forms.change_password import ChangePasswordForm
 from lms.lmsweb.forms.register import RegisterForm
@@ -554,7 +554,7 @@ def git_handler(exercise_id: int):
         user=http_basic_auth.current_user(),
         exercise_id=exercise_id,
         request=request,
-        base_repository_folder=REPOSITORY_FOLDER,
+        base_repository_folder=get_repository_folder(),
     )
     return git_service.handle_operation()
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -25,6 +25,9 @@
 from lms.models import notifications
 
 
+FAKE_PASSWORD = 'fake pass'
+
+
 @pytest.fixture(autouse=True, scope='session')
 def db_in_memory():
     """Binds all models to in-memory SQLite and creates all tables`"""
@@ -126,7 +129,7 @@ def get_logged_user(username: str) -> FlaskClient:
     client = webapp.test_client()
     client.post('/login', data={  # noqa: S106
         'username': username,
-        'password': 'fake pass',
+        'password': FAKE_PASSWORD,
     }, follow_redirects=True)
     return client
 
@@ -186,12 +189,11 @@ def create_user(
     role_name: str = RoleOptions.STUDENT.value, index: int = 1,
 ) -> User:
     username = f'{role_name}-{index}'
-    password = 'fake pass'
     return User.create(  # NOQA: S106
         username=username,
         fullname=f'A{role_name}',
         mail_address=f'so-{role_name}-{index}@mail.com',
-        password=password,
+        password=FAKE_PASSWORD,
         api_key='fake key',
         role=Role.by_name(role_name),
     )
@@ -215,7 +217,7 @@ def create_staff_user(index: int = 0) -> User:
 
 @pytest.fixture()
 def staff_password():
-    return 'fake pass'
+    return FAKE_PASSWORD
 
 
 @pytest.fixture
@@ -242,12 +244,11 @@ def student_user():
 def admin_user():
     admin_role = Role.get(Role.name == RoleOptions.ADMINISTRATOR.value)
     username = 'Yam'
-    password = 'fake pass'
     return User.create(  # NOQA: B106, S106
         username=username,
         fullname='Buya',
         mail_address='mymail@mail.com',
-        password=password,
+        password=FAKE_PASSWORD,
         api_key='fake key',
         role=admin_role,
     )
diff --git a/tests/test_git_solution.py b/tests/test_git_solution.py
@@ -0,0 +1,140 @@
+import base64
+import os.path
+import shutil
+import tempfile
+
+from flask.testing import FlaskClient
+
+from lms.lmsdb import models
+from lms.lmsweb import config, webapp
+from tests import conftest
+
+
+POST_NEW_REPOSITORY_BUFFER = \
+    b'00ab0000000000000000000000000000000000000000 ' \
+    b'c1d42352fc88ae88fde7713c23232d7d0703849a refs/heads/master\x00 ' \
+    b'report-status-v2 side-band-64k object-format=sha1 ' \
+    b'agent=git/2.30.10000PACK\x00\x00\x00\x02\x00\x00\x00\x03\x9d\nx' \
+    b'\x9c\x95\xccA\n\xc3 \x10@\xd1\xbd\xa7p_(3\x8e\x9a\x04J\xe8\xae' \
+    b'\x07\xe8\t\xa6\x99\xd1\n\x9a\x80\xd8\xfb7\xd0\x13t\xfb\xe1\xfd' \
+    b'\xd1U\xed$@\xc2\x92\x92\xdf\xd2\x1c\xf1\x15@\x84=\x12\xba\xa4' \
+    b'\xea\xe6e\x89\x88\x12\x12\x1a\xfe\x8c\xf7\xd1\xed\x83\xab}\x96=k' \
+    b'\xb7\xb7\xcc\xd5\x93\xbb\xe7\xc6\xa5^\xb7\xa3\xad\x16#\x91\x9b' \
+    b'\xc0\x07\xb2\x17 \x00s\xd6V\xc6\xd0\xbf\xa1){)\xe34\xbf\x83\xf9' \
+    b'\x02\xa5\x1f3_\xa0\x02x\x9c340031Q(\xc8,Id(M^\xc86;\xe0\xd1\x1d' \
+    b'\xefZ\x8bP\x17\x8eU\xd2\x17\xcb\xb6\xc6\x01\x00\xab:\x0b\xe64x' \
+    b'\x9c+O\xcc\xe6\x02\x00\x03\xe3\x01NvHX\x85>M\xf7I\xd6\x7fGZ' \
+    b'\x0e^\xc8\x82Q\xe3\xcb\xd9'
+
+
+POST_CLONE_REPOSITORY_BUFFER = \
+    b'0098want c1d42352fc88ae88fde7713c23232d7d0703849a multi_ack_detailed' \
+    b' no-done side-band-64k thin-pack ofs-delta deepen-since deepen-not' \
+    b' agent=git/2.30.1\n00000009done\n'
+
+
+class TestSendSolutionFromGit:
+    INFO_URL = 'info/refs'
+    GET_METHOD = FlaskClient.get.__name__
+    POST_METHOD = FlaskClient.post.__name__
+
+    temp_folder = None
+
+    @classmethod
+    def setup_class(cls):
+        cls.temp_folder = tempfile.mkdtemp()
+
+    def setup_method(self, method):
+        config._REPOSITORY_FOLDER = os.path.join(self.temp_folder, method.__name__)
+
+    @classmethod
+    def teardown_class(cls):
+        if cls.temp_folder and os.path.exists(cls.temp_folder):
+            shutil.rmtree(cls.temp_folder)
+
+    @staticmethod
+    def _get_formatted_git_url(exercise: models.Exercise, rel_path: str) -> str:
+        return f'/git/{exercise.id}.git/{rel_path}'
+
+    @staticmethod
+    def _send_git_request(
+            username: str,
+            method_name: str,
+            url: str,
+            data=None,
+            service=None,
+            password=conftest.FAKE_PASSWORD,
+    ):
+        client = webapp.test_client()
+        encoded_credentials = base64.b64encode(f'{username}:{password}'.encode()).decode()
+        headers = (
+            ('Authorization', f'Basic {encoded_credentials}'),
+        )
+        query_string = None
+        if service is not None:
+            query_string = {'service': service}
+        return getattr(client, method_name)(url, query_string=query_string, headers=headers, data=data)
+
+    def test_not_authorized_access(self, exercise: models.Exercise, student_user: models.User):
+        client = conftest.get_logged_user(student_user.username)
+        response = client.get(self._get_formatted_git_url(exercise, self.INFO_URL))
+        assert response.status_code == 401
+
+    def test_not_existing_user(self, exercise: models.Exercise):
+        response = self._send_git_request(
+            username='not-exists',
+            method_name=self.GET_METHOD,
+            url=self._get_formatted_git_url(exercise, self.INFO_URL),
+        )
+        assert response.status_code == 401
+
+    def test_invalid_user_password(self, exercise: models.Exercise, student_user: models.User):
+        response = self._send_git_request(
+            username=student_user.username,
+            method_name=self.GET_METHOD,
+            url=self._get_formatted_git_url(exercise, self.INFO_URL),
+            password='not real password'
+        )
+        assert response.status_code == 401
+
+    def test_push_exercise(self, exercise: models.Exercise, student_user: models.User):
+        git_receive_pack = 'git-receive-pack'
+        response = self._send_git_request(
+            username=student_user.username,
+            method_name=self.GET_METHOD,
+            url=self._get_formatted_git_url(exercise, self.INFO_URL),
+            service=git_receive_pack,
+        )
+
+        assert response.status_code == 200
+        assert response.data.startswith(b'001f#')
+
+        response = self._send_git_request(
+            username=student_user.username,
+            method_name=self.POST_METHOD,
+            url=self._get_formatted_git_url(exercise, git_receive_pack),
+            data=POST_NEW_REPOSITORY_BUFFER,
+        )
+        assert response.status_code == 200
+        assert response.data.startswith(b'0030\x01000eunpack ok\n0019ok refs/heads/master\n00000000')
+
+    def test_get_exercise(self, exercise: models.Exercise, student_user: models.User):
+        git_upload_pack = 'git-upload-pack'
+        self.test_push_exercise(exercise, student_user)
+        response = self._send_git_request(
+            username=student_user.username,
+            method_name=self.GET_METHOD,
+            url=self._get_formatted_git_url(exercise, self.INFO_URL),
+            service=git_upload_pack,
+        )
+        assert response.status_code == 200
+        assert response.data.startswith(b'001e# service=git-upload-pack')
+
+        response = self._send_git_request(
+            username=student_user.username,
+            method_name=self.POST_METHOD,
+            url=self._get_formatted_git_url(exercise, git_upload_pack),
+            data=POST_CLONE_REPOSITORY_BUFFER,
+        )
+        assert response.status_code == 200
+        assert response.data.startswith(b'0008NAK\n0023\x02Enumerating objects: 3, done.')

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`)`
`25`	`25`	`from lms.lmsweb.config import (`
`26`	`26`	`CONFIRMATION_TIME, LANGUAGES, LIMITS_PER_HOUR,`
`27`		`- LIMITS_PER_MINUTE, LOCALE, MAX_UPLOAD_SIZE, REPOSITORY_FOLDER,`
	`27`	`+ LIMITS_PER_MINUTE, LOCALE, MAX_UPLOAD_SIZE, get_repository_folder,`
`28`	`28`	`)`
`29`	`29`	`from lms.lmsweb.forms.change_password import ChangePasswordForm`
`30`	`30`	`from lms.lmsweb.forms.register import RegisterForm`
`@@ -554,7 +554,7 @@ def git_handler(exercise_id: int):`
`554`	`554`	`user=http_basic_auth.current_user(),`
`555`	`555`	`exercise_id=exercise_id,`
`556`	`556`	`request=request,`
`557`		`- base_repository_folder=REPOSITORY_FOLDER,`
	`557`	`+ base_repository_folder=get_repository_folder(),`
`558`	`558`	`)`
`559`	`559`	`return git_service.handle_operation()`
`560`	`560`