Added Go-Jek Parking Lot Assignment Python

Author: vineetchoudhary

Go-Jek/Go-Jek-Parking-Lot-Assignment-Python/.gitignore

@@ -0,0 +1,108 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+environment/
+
+# vscode
+.vscode/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/

Go-Jek/Go-Jek-Parking-Lot-Assignment-Python/Constants.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python3
+
+CREATE_PARKING_LOT = 'create_parking_lot'
+PARK_CAR = 'park'
+CAR_DEPARTURE = 'leave'
+LOT_STATUS = 'status'
+SEARCH_SLOT_BY_COLOUR = 'slot_numbers_for_cars_with_colour'
+SEARCH_CAR_BY_COLOUR = 'registration_numbers_for_cars_with_colour'
+SEARCH_SLOT_BY_CAR_NUMBER = 'slot_number_for_registration_number'
+EXIT = 'exit'

Go-Jek/Go-Jek-Parking-Lot-Assignment-Python/Dockerfile

@@ -0,0 +1,3 @@
+FROM python:alpine
+ADD . /app
+WORKDIR /app

Go-Jek/Go-Jek-Parking-Lot-Assignment-Python/ParkingLot.py

@@ -0,0 +1,59 @@
+#!/usr/bin/env python3
+
+import sys
+from Constants import *
+from Utilities import (ParkingLot, create_parking_lot, park_car, car_departure,
+                       lot_status, car_by_colour, slot_by_car_number, slot_by_colour)
+
+
+def executeCommand(parkingLot, command):
+    if command[0] == CREATE_PARKING_LOT:
+        parkingLot = create_parking_lot(command[1])
+    elif command[0] == PARK_CAR:
+        print(park_car(parkingLot, command[1], command[2]))
+    elif command[0] == CAR_DEPARTURE:
+        print(car_departure(parkingLot, command[1]))
+    elif command[0] == LOT_STATUS:
+        print(lot_status(parkingLot).rstrip('\n'))
+    elif command[0] == SEARCH_SLOT_BY_CAR_NUMBER:
+        print(slot_by_car_number(parkingLot, command[1]).rstrip(', '))
+    elif command[0] == SEARCH_CAR_BY_COLOUR:
+        print(car_by_colour(parkingLot, command[1]).rstrip(', '))
+    elif command[0] == SEARCH_SLOT_BY_COLOUR:
+        print(slot_by_colour(parkingLot, command[1]).rstrip(', '))
+    else:
+        print('Command is not applicable')
+    return parkingLot
+
+
+def commandMode(parkingLot):
+    try:
+        command = input().split()
+        while command[0] != EXIT:
+            parkingLot = executeCommand(parkingLot, command)
+            command = input().split()
+    except Exception as e:
+        print(e)
+
+
+def fileReaderMode(parkingLot, fileName):
+    try:
+        with open(fileName) as file:
+            commands = file.readlines()
+            for command in commands:
+                parkingLot = executeCommand(
+                    parkingLot, command.replace('\n', '').split())
+    except Exception as e:
+        print(e)
+
+
+def main():
+    parkingLot = None
+    if len(sys.argv) > 1:
+        fileReaderMode(parkingLot, sys.argv[1])
+    else:
+        commandMode(parkingLot)
+
+
+if __name__ == '__main__':
+    main()

Go-Jek/Go-Jek-Parking-Lot-Assignment-Python/README.md

@@ -0,0 +1,97 @@
+# Go-Jek Parking Lot Assignment (Python)
+
+## 1. Problem Statment
+Design a Parking lot which can hold `n` Cars. Every car been issued a ticket for a slot and the slot been assigned based on the nearest to the entry. The system should also return some queries such as:
+
+- Registration numbers of all cars of a particular colour.
+- Slot number in which a car with a given registration number is parked.
+- Slot numbers of all slots where a car of a particular colour is parked.
+
+## 2. Solution Approach
+A car consist of Registration number, slot number and it's colour. Likewise our Parking Lot consist slots. For not making it too complicated, I choose a python dictionary for storing cars on slots and implemented the functionalities as accordingly.
+
+## 3. Supported Commands
+
+- `create_parking_lot` <`n`>   
+To create a Parking lot. Where `n` is the size of the parking lot
+
+- `park` <`registration_number`> <`colour`>   
+To park the car in the parking lot and prints the allocated slot in the parking lot. Where `registration_number` is given registration number for the car and `colour` is given colour for the car
+
+- `leave` <`slot`>   
+To leave the parking lot from desired slot and prints the leaving slot. given slot number. Where `slot` is given sloat number
+
+- `status`   
+To check the status of Parking Lot
+
+- `slot_numbers_for_cars_with_colour` <`colour`>   
+To prints the registration number of the cars for the given colour. Where `color` is given colour
+
+- `slot_number_for_registration_number` <`registration_number`>   
+prints the slot number of the cars for the given number. Where `registration_number` is given registration number.
+
+- `registration_numbers_for_cars_with_colour` <`colour`>   
+To prints the slot number of the cars for the given colour.  Where `colour` is given colour.
+
+## 4. Running Application
+#### 4.1 Running the application in File mode:
+
+```python
+./ParkingLot.py input.txt
+```
+
+#### 4.2 Running the application in Interactive mode:
+
+```python
+./ParkingLot.py
+```
+
+## 5. Test Cases
+- Total number of test cases - 14
+- Code coverage - 86%
+
+#### 5.1 For running the tests
+
+```python
+python Tests.py
+```
+
+#### 5.2 For calculating code coverage
+```python
+coverage run Tests.py 
+coverage report
+```
+
+## 6. Running the application in a Docker Container
+
+#### Build the image:
+
+```python
+docker build -t parkinglot:1.0 .
+```
+
+#### 6.1 Running the application in Interactive mode:
+
+```python
+docker run -it parkinglot:1.0 ./ParkingLot.py
+```
+
+#### 6.2 Running the application in File mode:
+
+```python
+docker run -it parkinglot:1.0 ./ParkingLot.py input.txt
+```
+
+## 7. Possible errors
+
+When using running application in Docker, if it gives this error:
+
+```bash
+docker: Error response from daemon: OCI runtime create failed: container_linux.go:348: starting container process caused "exec: \"./ParkingLot.py\": permission denied": unknown.
+```
+
+just change the permissions by running
+
+```bash
+sudo chmod +x ./ParkingLot.py
+```

Go-Jek/Go-Jek-Parking-Lot-Assignment-Python/Tests.py

@@ -0,0 +1,87 @@
+import unittest
+from Utilities import create_parking_lot, park_car, parking_lot_is_full, car_departure, \
+    car_by_colour, slot_by_car_number, slot_by_colour
+
+
+class TestParkingLotUtilities(unittest.TestCase):
+    """
+    will test the endpoints
+    """
+
+    def test_create_parking_lot(self):
+        testParkingLot = create_parking_lot(str(6))
+        self.assertEqual(len(testParkingLot.get_slots()), 6)
+
+    def test_parking_lot_is_full(self):
+        testParkingLot = create_parking_lot(str(6))
+        self.assertEqual(parking_lot_is_full(testParkingLot), False)
+
+    def test_park_car_lot_not_defined(self):
+        testString = park_car(None, 'KA-01-AA-1111', 'White')
+        self.assertEqual('Parking lot is not defined', testString)
+
+    def test_park_car_lot_allocated(self):
+        testParkingLot = create_parking_lot(str(6))
+        testString = park_car(testParkingLot, 'KA-01-AA-1112', 'White')
+        self.assertEqual('Allocated slot number: 1', testString)
+
+    def test_park_car_lot_full(self):
+        testParkingLot = create_parking_lot(str(1))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1112', 'White')
+        testString = park_car(testParkingLot, 'KA-01-AA-1113', 'White')
+        self.assertEqual('Sorry, parking lot is full', testString)
+
+    def test_car_departure_empty(self):
+        testParkingLot = create_parking_lot(str(6))
+        testString = car_departure(testParkingLot, '1')
+        self.assertEqual('Sorry, parking lot is empty', testString)
+
+    def test_car_departure_free(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1114', 'White')
+        testString = car_departure(testParkingLot, '1')
+        self.assertEqual('Slot number 1 is free', testString)
+
+    def test_car_departure_cannot_exit(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1115', 'White')
+        testString = car_departure(testParkingLot, '7')
+        self.assertEqual('Cannot exit slot: 7 as no such exist!', testString)
+
+    def test_car_departure_slot_free(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1116', 'White')
+        testString = car_departure(testParkingLot, '2')
+        self.assertEqual('No car at Slot number 2', testString)
+
+    def test_car_departure_not_defined(self):
+        testString = car_departure(None, '1')
+        self.assertEqual('Parking lot is not defined', testString)
+
+    def test_car_by_colour(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1117', 'White')
+        testString = car_by_colour(testParkingLot, 'White')
+        self.assertEqual(testString, 'KA-01-AA-1117, ')
+
+    def test_slot_by_car_number_not_found(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1118', 'White')
+        testString = slot_by_car_number(testParkingLot, 'KA-01-AA-1113')
+        self.assertEqual(testString, 'Not found')
+
+    def test_slot_by_car_number(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1103', 'White')
+        testString = slot_by_car_number(testParkingLot, 'KA-01-AA-1103')
+        self.assertEqual(testString, '1, ')
+
+    def test_slot_by_colour(self):
+        testParkingLot = create_parking_lot(str(6))
+        testParkString = park_car(testParkingLot, 'KA-01-AA-1119', 'White')
+        testString = slot_by_colour(testParkingLot, 'White')
+        self.assertEqual(testString, '1, ')
+
+
+if __name__ == '__main__':
+    unittest.main()