Skip to content

Latest commit

 

History

History
1402 lines (1062 loc) · 77 KB

README.md

File metadata and controls

1402 lines (1062 loc) · 77 KB
Raw

Plutus

Note: This file is not formatted in interest of time. Please use readme.docx file for reader friendly version. This file exists as best practice and will be modified later.

Name of Project : Plutus

Pronounced as: pluːtəs/ Greek: Πλοῦτος

History Plutus was Greek god of wealth

Vision:

Plutus is an application for MYOB internal payroll team members to view monthly pay slip for a given employee, so that payroll team members don’t have to calculate employee salary manually.

Scope:

As a user of plutus, I should be able to view payroll slip of a given employee in following format:

Monthly Payslip for: “Employee name”

Gross Monthly Income: Gross monthly salary in AUD prefixed with “$”

Monthly Income Tax: Monthly Income tax in AUD prefixed with “$”

Net Monthly Income: Net monthly income in AUD prefixed with “$”

Example:

Monthly Payslip for: “Mary Song”

Gross Monthly Income: $5000

Monthly Income Tax: $500

Net Monthly Income: $4500

So that, I don’t have to calculate employee salary manually.

Assumptions:

  1. Vishal is PO, BA, Tech lead and Developer for this project
  2. There is no need to data ingestion from source
  3. In first phase solution will be delivered using static excel spreadsheets having data in them, so tax slab table is constant.
  4. In second phase depending on business requirements, solution could be delivered using Kafka/Databases/App integration ..etc
  5. Phase 2 is not in scope for this delivery
  6. Code is designed to be executed on Mac as of now.
  7. Python3.7 is required to execute this code
  8. Input CSV contains 1 row per tax slab format. Row format is ‘low_band_income_range’,’high_band_income_range’,’tax_slab_rate’.
  9. Since sample output does not have decimal, so the decimal part is not required in output.
  10. There is no rule for rounding off data.

Prerequisites:

  1. Docker version 19.03.5 or greater on macbook
  2. If behind proxy, Docker proxy configuration is in place. Please see: https://docs.docker.com/network/proxy/

Instructions on how to execute:

  1. Copy or clone the entire project. Cloning can be done from https://github.com/svishal9/plutus
  2. Change directory to project root folder which is named as “plutus”
  3. Start the application API using the command “./start_plutus.sh”

./start_plutus.sh

  1. Execute the command as given in requirement. For example:

./GenerateMonthlyPayslip "Mary Song" 60000

Sample output:

Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

  1. Once done, then stop the application using the command “./stop_plutus.sh” as follows:

./stop_plutus.sh

Architecture:

Infrastructure arch 

Main components of python app 

Workflow arch 

Initial Iteration:

Expected behaviour:

As a business user of plutus, I should be able to use plutus from console, provide input as employee name and monthly salary, and get payroll details in following format:

Monthly Payslip for: “Mary Song” Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

Additional Information (including Business Logic):

The annual tax rates are as follows 

Taxable Income Tax on this income $0 - $20,000 $0 $20,001 - $40,000 10c for each $1 over $20,000 $40,001 - $80,000 20c for each $1 over $40,000 $80,0001 - $180,000 30c for each $1 over $80,000 $180,001 and over 40c for each $1 over $180,000

For an employee with annual salary of $60,000:

  1. Gross monthly income :-- Total annual salary/12  $60,000/12 = $5000
  2. Monthly income tax :-- Calculated as per annual tax rate given above  ((20,000 * 0) + ((40,000 – 20,000) * 0.1) + ((60,000 – 40,000) * 0.2 ))/12 = (0 + (20,000 * 0.1) + (20,000 * 0.2))/12 = (0 + 2,000 + 4,000)/12 = $500
  3. Net monthly income :-- Gross monthly income – Monthly income tax  5,000 – 500 = 4,500

Example console input:

GenerateMonthlyPayslip "Mary Song" 60000 Example Output:

Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

Domain Bounded Context Design:

High Level Workflow:

Standards:

  1. All standards of pylint
  2. All variables are in camel case.
  3. All Methods start with verb
  4. All files and folder names are in lower case separated by “_”
  5. Strictly directed acyclic

TDD1:

Create a function to get the tax amount for given annual salary. Test Case:

import GenerateMonthlyPayslip.app as GenerateMonthlyPayslip import pytest

def test_calculateTax(): assert GenerateMonthlyPayslip.GetTax(60000) == 6000, 'Tax calculation not correct'

Iteration 1 code:

taxSlabRanges = [ [0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30] ] maxTaxSlabIncome = 180000; maxTaxSlabRate = 40

def GetTax( annualIncome ):

annualTaxPayable = []
for taxSlab in taxSlabRanges:
    if all([annualIncome > taxSlab[0], annualIncome > taxSlab[1]]):
        annualTaxPayable.append((taxSlab[1] - taxSlab[0]) * taxSlab[2] / 100)
    elif all([annualIncome > taxSlab[0], annualIncome <= taxSlab[1]]):
        annualTaxPayable.append((annualIncome - taxSlab[0]) * taxSlab[2] / 100)
if annualIncome > maxTaxSlabIncome:
    annualTaxPayable.append((annualIncome - maxTaxSlabIncome) * maxTaxSlabRate / 100)
return int(sum(annualTaxPayable))

if name == 'main': print(GetTax(60000))

Parameterizing input to calculate tax:

import argparse

taxSlabRanges = [ [0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30] ] maxTaxSlabIncome = 180000; maxTaxSlabRate = 40

def GetTax( annualIncome ):

annualTaxPayable = []
for taxSlab in taxSlabRanges:
    if all([annualIncome > taxSlab[0], annualIncome > taxSlab[1]]):
        annualTaxPayable.append((taxSlab[1] - taxSlab[0]) * taxSlab[2] / 100)
    elif all([annualIncome > taxSlab[0], annualIncome <= taxSlab[1]]):
        annualTaxPayable.append((annualIncome - taxSlab[0]) * taxSlab[2] / 100)
if annualIncome > maxTaxSlabIncome:
    annualTaxPayable.append((annualIncome - maxTaxSlabIncome) * maxTaxSlabRate / 100)
return int(sum(annualTaxPayable))

if name == 'main': parser = argparse.ArgumentParser(description='Generate Payslip for an employee') parser.add_argument('--gross-annual-salary','-gas', required=True, dest='grossAnnualSalary', help='gross annual salary of employee') args = parser.parse_args() grossAnnualSalary=int(args.grossAnnualSalary) print(grossAnnualSalary) print(GetTax(grossAnnualSalary))

Test case result:

========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 1 item

tests\unit\test_u_app.py . [100%]

=========================================================================================================== 1 passed in 0.04s ===========================================================================================================

TDD2:

CSV file is:

low_band_income_range high_band_income_range tax_slab_rate 0 20000 0 20000 40000 10 40000 80000 20 80000 180000 30 180000 -1 40

Read from file in above given format and create tax slab ranges, test case is:

def test_readStaticTaxFile(): maxSlabAnnualIncome, maxSlabTaxRate, tax_slab_rate_list = ReadTaxSlabFile.readTaxFile() assert maxSlabAnnualIncome == 180000, 'Maximum Tax Slab annual income not correct' assert maxSlabTaxRate == 40, 'Maximum Tax Slab annual income not correct' assert tax_slab_rate_list == [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]] , 'Tax Slab rate is not correct'

Iteration 1 code is:

import csv import os

def readTaxFile(): inputStaticTaxSlabFile = 'StaticInput\tax_slab.csv' tax_slab_rate_list=[] maxSlabAnnualIncome=0 maxSlabTaxRate=0 with open(inputStaticTaxSlabFile) as csvfile: csv_file = csv.reader(csvfile) header = csv_file.next() raw_data = csv_file for row in raw_data: if(row[1] == '-1'): maxSlabAnnualIncome = int(row[0]) maxSlabTaxRate = int(row[2]) else: tax_slab_list=[int(row[0]),int(row[1]),int(row[2])] tax_slab_rate_list.append(tax_slab_list) return maxSlabAnnualIncome,maxSlabTaxRate,tax_slab_rate_list

Test results are:

Got few file not found exceptions:

C:\Users\svishal\PycharmProjects\plutus>pytest ========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 2 items

tests\unit\test_u_app.py .F [100%]

=============================================================================================================== FAILURES ================================================================================================================ ________________________________________________________________________________________________________ test_readStaticTaxFile _________________________________________________________________________________________________________

def test_readStaticTaxFile():

  maxSlabAnnualIncome, maxSlabTaxRate, tax_slab_rate_list = ReadTaxSlabFile.readTaxFile()

tests\unit\test_u_app.py:9:

def readTaxFile():
    inputStaticTaxSlabFile = 'StaticInput\\tax_slab.csv'
    tax_slab_rate_list=[]
    maxSlabAnnualIncome=0
    maxSlabTaxRate=0

  with open(inputStaticTaxSlabFile) as csvfile:

E FileNotFoundError: [Errno 2] No such file or directory: 'StaticInput\tax_slab.csv'

GenerateMonthlyPayslip\read_tax_slab.py:8: FileNotFoundError ====================================================================================================== 1 failed, 1 passed in 0.12s ======================================================================================================

Modified code to fix the path of file:

import csv import os

def readTaxFile(): inputStaticTaxSlabFile = os.getcwd() + '\GenerateMonthlyPayslip\StaticInput\tax_slab.csv' tax_slab_rate_list=[] maxSlabAnnualIncome=0 maxSlabTaxRate=0 with open(inputStaticTaxSlabFile) as csvfile: csv_file = csv.reader(csvfile) header = csv_file.next() raw_data = csv_file for row in raw_data: if(row[1] == '-1'): maxSlabAnnualIncome = int(row[0]) maxSlabTaxRate = int(row[2]) else: tax_slab_list=[int(row[0]),int(row[1]),int(row[2])] tax_slab_rate_list.append(tax_slab_list) return maxSlabAnnualIncome,maxSlabTaxRate,tax_slab_rate_list

Test results:

C:\Users\svishal\PycharmProjects\plutus>pytest ========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 2 items

tests\unit\test_u_app.py .. [100%]

=========================================================================================================== 2 passed in 0.06s ===========================================================================================================

Refactoring code in GetTax function:

def GetTax( annualIncome ):

annualTaxPayable = []
maxTaxSlabIncome,maxTaxSlabRate, taxSlabRanges = ReadTaxSlabFile.readTaxFile()
for taxSlab in taxSlabRanges:
    if all([annualIncome > taxSlab[0], annualIncome > taxSlab[1]]):
        annualTaxPayable.append((taxSlab[1] - taxSlab[0]) * taxSlab[2] / 100)
    elif all([annualIncome > taxSlab[0], annualIncome <= taxSlab[1]]):
        annualTaxPayable.append((annualIncome - taxSlab[0]) * taxSlab[2] / 100)
if annualIncome > maxTaxSlabIncome:
    annualTaxPayable.append((annualIncome - maxTaxSlabIncome) * maxTaxSlabRate / 100)
return int(sum(annualTaxPayable))

Running tests again:

C:\Users\svishal\PycharmProjects\plutus>pytest ========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 2 items

tests\unit\test_u_app.py .. [100%]

=========================================================================================================== 2 passed in 0.06s ===========================================================================================================

TDD3:

Calculate gross monthly salary, net monthly tax payable and net monthly salary given annual salary and annual tax payable. So, the test is as follows:

def test_calculate_salary_details(): grossMonthlySalary, monthlyTaxPayable, netMonthlySalary=SalaryDetails(60000,6000) assert grossMonthlySalary == 5000, 'Gross monthly income not calculated correctly' assert monthlyTaxPayable == 500, 'Monthly tax payable not calculated correctly' assert netMonthlySalary == 4500, 'Net monthly salary not calculated correctly'

Initial code for this test is as follows:

def CalculateNetMonthlyIncome(grossMonthlyIncome,netMonthlyTax): return grossMonthlyIncome-netMonthlyTax

def CalculateGrossMonthlyIncome(grossAnnualIncome): return grossAnnualIncome/12

def CalculateNetMonthlyTax(annualTaxToBePaid): return annualTaxToBePaid/12

def SalaryDetails(grossAnnualIncome,annualTaxToBePaid): grossMonthlySalary=CalculateGrossMonthlyIncome(grossAnnualIncome) monthlyTaxPayable=CalculateNetMonthlyTax(annualTaxToBePaid) netMonthlySalary=CalculateNetMonthlyIncome(grossMonthlySalary,monthlyTaxPayable) return grossMonthlySalary,monthlyTaxPayable,netMonthlySalary

The test results are as follows:

C:\Users\svishal\PycharmProjects\plutus>pytest ========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 3 items

tests\unit\test_u_app.py ... [100%]

=========================================================================================================== 3 passed in 0.13s ===========================================================================================================

Design Decision 1:

The methods GetAnnualTax and SalaryDetails are objective in nature. They could be used by different processes in future like Finance, HR ..etc. For example, this application just prints the payslip but there could be an application from HR which could use these methods to calculate and insert salary details to their database and analyse further or use it for other application. So, it makes sense to have objective approach towards these methods and plan if they could be reused as library methods instead of class methods. Also, primarily this decision is to expand the scope outside classes as well and showcase use of library methods with classes. In real world scenario this decision may or may not be part of actual solution depending on requirements.

Refactored code:

So far refactored code looks like:

import argparse from calculate_annual_tax import GetAnnualTax from calculate_net_monthly_income_details import SalaryDetails

def GetEmployeeAnnualTax(grossAnnualSalary): return GetAnnualTax(grossAnnualSalary)

def GetEmployeeMonthlyIncomeDetails(grossAnnualSalary,annualTaxToBePaid): return SalaryDetails(grossAnnualSalary,annualTaxToBePaid)

if name == 'main': parser = argparse.ArgumentParser(description='Generate Payslip for an employee') parser.add_argument('--gross-annual-salary','-gas', required=True, dest='grossAnnualSalary', help='gross annual salary of employee') args = parser.parse_args() grossAnnualSalary=int(args.grossAnnualSalary) print(grossAnnualSalary) annualTaxPayable=GetEmployeeAnnualTax(grossAnnualSalary) grossMonthlySalary, monthlyTaxPayable, netMonthlySalary = SalaryDetails(grossAnnualSalary,annualTaxPayable) print(grossMonthlySalary) print(monthlyTaxPayable) print(netMonthlySalary)

TDD4: Print the salary details, the test case is:

def test_print_employee_monthly_payslip(): employeeSelected = Employee('Mary Song',5000,500,4500) employeeSelected.PrintEmployeePayslip() expectedOutput = 'Monthly Payslip for: "Mary Song"\nGross Monthly Income: $5000\nMonthly Income Tax: $500\nNet Monthly Income: $4500' assert employeeSelected.PrintEmployeePayslip() == expectedOutput , 'Payslip output is not matching as expected'

The code to satisfy above test case is as follows:

class Employee: def init(self, fullName, grossMonthlySalary, netMonthlyTaxPayable, netMonthlySalary): self.__employeeFullName = fullName self.__employeeGrossMonthlySalary = grossMonthlySalary self.__employeeNetMonthlyTaxPayable = netMonthlyTaxPayable self.__employeeNetMonthlySalary = netMonthlySalary

def PrintEmployeePayslip(self):
    payslipOutputMessage='Monthly Payslip for: "' + self.__employeeFullName + '"\n'
    payslipOutputMessage += 'Gross Monthly Income: $' + str(self.__employeeGrossMonthlySalary) + '\n'
    payslipOutputMessage += 'Monthly Income Tax: $' + str(self.__employeeNetMonthlyTaxPayable) + '\n'
    payslipOutputMessage += 'Net Monthly Income: $' + str(self.__employeeNetMonthlySalary)
    print(payslipOutputMessage)
    return payslipOutputMessage

The test results are:

C:\Users\svishal\PycharmProjects\plutus>pytest ========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 4 items

tests\unit\test_u_app.py .... [100%]

=========================================================================================================== 4 passed in 0.13s ===========================================================================================================

Refactoring the code, it looks like as follows:

import argparse from calculate_annual_tax import GetAnnualTax from calculate_net_monthly_income_details import SalaryDetails from print_employee_monthly_payslip import Employee

def GetEmployeeAnnualTax(grossAnnualSalary): return GetAnnualTax(grossAnnualSalary)

def GetEmployeeMonthlyIncomeDetails(grossAnnualSalary,annualTaxToBePaid): return SalaryDetails(grossAnnualSalary,annualTaxToBePaid)

if name == 'main': parser = argparse.ArgumentParser(description='Generate Payslip for an employee') parser.add_argument('--employee-full-name','-efn', required=True, dest='employeeFullName', help='Full name of employee') parser.add_argument('--gross-annual-salary','-gas', required=True, dest='grossAnnualSalary', help='gross annual salary of employee') args = parser.parse_args() employeeFullName=args.employeeFullName grossAnnualSalary=int(args.grossAnnualSalary) annualTaxPayable=GetEmployeeAnnualTax(grossAnnualSalary) grossMonthlySalary, monthlyTaxPayable, netMonthlySalary = SalaryDetails(grossAnnualSalary,annualTaxPayable) employeeSelected=Employee(employeeFullName,grossMonthlySalary, monthlyTaxPayable, netMonthlySalary) employeeSelected.PrintEmployeePayslip()

The output looks like:

C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=60000 -efn="Mary Song" Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000.0 Monthly Income Tax: $500.0 Net Monthly Income: $4500.0

It could be clearly seen that the amount has decimal bits which was not in sample output and it was one of assumptions that output is required in int only. So, modified(type casted) the methods for calculation.

def CalculateNetMonthlyIncome(grossMonthlyIncome,netMonthlyTax): return int(grossMonthlyIncome-netMonthlyTax)

def CalculateGrossMonthlyIncome(grossAnnualIncome): return int(grossAnnualIncome/12)

def CalculateNetMonthlyTax(annualTaxToBePaid): return int(annualTaxToBePaid/12)

And now the output is:

C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=60000 -efn="Mary Song" Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

Which is as per expectation.

Looking at unit tests again:

C:\Users\svishal\PycharmProjects\plutus>pytest ========================================================================================================== test session starts ========================================================================================================== platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 4 items

tests\unit\test_u_app.py .... [100%]

=========================================================================================================== 4 passed in 0.12s ===========================================================================================================

TDD5:

Validate the annual salary input to be integer and greater than 0. Test case is:

assert isinstance(int(grossAnnualSalary),int),'Gross Annual Salary is not int' assert grossAnnualSalaryInt >= 0, 'Gross Annual Salary cannot be less than 0'

Since this condition is always true, added assert:

def ValidateConvertAnnualSalary(grossAnnualSalary): assert isinstance(int(grossAnnualSalary),int),'Gross Annual Salary is not int' grossAnnualSalaryInt = int(grossAnnualSalary) assert grossAnnualSalaryInt >= 0, 'Gross Annual Salary cannot be less than 0' return grossAnnualSalaryInt

Refactoring code as:

import argparse import logging from calculate_annual_tax import GetAnnualTax from calculate_net_monthly_income_details import SalaryDetails from print_employee_monthly_payslip import Employee import logging_config from types import *

log = logging.getLogger('generate_monthly_payslip.app')

log.setLevel('INFO')

def GetEmployeeAnnualTax(grossAnnualSalary): return GetAnnualTax(grossAnnualSalary)

def GetEmployeeMonthlyIncomeDetails(grossAnnualSalary,annualTaxToBePaid): return SalaryDetails(grossAnnualSalary,annualTaxToBePaid)

def ValidateConvertAnnualSalary(grossAnnualSalary): assert isinstance(int(grossAnnualSalary),int),'Gross Annual Salary is not int' grossAnnualSalaryInt = int(grossAnnualSalary) assert grossAnnualSalaryInt >= 0, 'Gross Annual Salary cannot be less than 0' return grossAnnualSalaryInt

def Run(employeeFullName,grossAnnualSalaryInput): grossAnnualSalary=ValidateConvertAnnualSalary(grossAnnualSalaryInput) annualTaxPayable=GetEmployeeAnnualTax(grossAnnualSalary) grossMonthlySalary, monthlyTaxPayable, netMonthlySalary = SalaryDetails(grossAnnualSalary,annualTaxPayable) employeeSelected=Employee(employeeFullName,grossMonthlySalary, monthlyTaxPayable, netMonthlySalary) employeeSelected.PrintEmployeePayslip()

if name == 'main': log.info('Welcome to the world of "Plutus". Starting payslip generator application.') parser = argparse.ArgumentParser(description='Generate Payslip for an employee') parser.add_argument('--employee-full-name','-efn', required=True, dest='employeeFullName', help='Full name of employee') parser.add_argument('--gross-annual-salary','-gas', required=True, dest='grossAnnualSalary', help='gross annual salary of employee') log.debug('Parsing parameters') args = parser.parse_args() Run(args.employeeFullName,args.grossAnnualSalary)

The test results are as follows:

C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=60000 -efn="Mary Song" INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

(untitled) C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=-60000 -efn="Mary Song" INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Traceback (most recent call last): File "GenerateMonthlyPayslip\app.py", line 39, in Run(args.employeeFullName,args.grossAnnualSalary) File "GenerateMonthlyPayslip\app.py", line 26, in Run grossAnnualSalary=ValidateConvertAnnualSalary(grossAnnualSalaryInput) File "GenerateMonthlyPayslip\app.py", line 22, in ValidateConvertAnnualSalary assert grossAnnualSalaryInt >= 0, 'Gross Annual Salary cannot be less than 0' AssertionError: Gross Annual Salary cannot be less than 0

(untitled) C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=-6a0 -efn="Mary Song" INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Traceback (most recent call last): File "GenerateMonthlyPayslip\app.py", line 39, in Run(args.employeeFullName,args.grossAnnualSalary) File "GenerateMonthlyPayslip\app.py", line 26, in Run grossAnnualSalary=ValidateConvertAnnualSalary(grossAnnualSalaryInput) File "GenerateMonthlyPayslip\app.py", line 20, in ValidateConvertAnnualSalary assert isinstance(int(grossAnnualSalary),int),'Gross Annual Salary is not int' ValueError: invalid literal for int() with base 10: '-6a0'

TDD6:

Validate employee name, test case is:

assert name.isalpha(),'Name can contain only alphabets and spaces'

The code for this test case is:

def ValidateName(fullName): for name in fullName.split(' '): print(name) assert name.isalpha(),'Name can contain only alphabets and spaces'

Changed Run() method to refactor the code:

def ValidateName(fullName): for name in fullName.split(' '): print(name) assert name.isalpha(),'Name can contain only alphabets and spaces'

def Run(employeeFullName,grossAnnualSalaryInput): ValidateName(employeeFullName) grossAnnualSalary=ValidateConvertAnnualSalary(grossAnnualSalaryInput) annualTaxPayable=GetEmployeeAnnualTax(grossAnnualSalary) grossMonthlySalary, monthlyTaxPayable, netMonthlySalary = SalaryDetails(grossAnnualSalary,annualTaxPayable) employeeSelected=Employee(employeeFullName,grossMonthlySalary, monthlyTaxPayable, netMonthlySalary) employeeSelected.PrintEmployeePayslip()

Test results are:

C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=60000 -efn="Mary Song" INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Mary Song Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

(untitled) C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=60000 -efn="Mary-Song" INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Mary-Song Traceback (most recent call last): File "GenerateMonthlyPayslip\app.py", line 47, in Run(args.employeeFullName,args.grossAnnualSalary) File "GenerateMonthlyPayslip\app.py", line 33, in Run ValidateName(employeeFullName) File "GenerateMonthlyPayslip\app.py", line 28, in ValidateName assert name.isalpha(),'Name can contain only alphabets and spaces' AssertionError: Name can contain only alphabets and spaces

(untitled) C:\Users\svishal\PycharmProjects\plutus>python GenerateMonthlyPayslip\app.py -gas=60000 -efn="Mary\ Song" INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Mary
Traceback (most recent call last): File "GenerateMonthlyPayslip\app.py", line 47, in Run(args.employeeFullName,args.grossAnnualSalary) File "GenerateMonthlyPayslip\app.py", line 33, in Run ValidateName(employeeFullName) File "GenerateMonthlyPayslip\app.py", line 28, in ValidateName assert name.isalpha(),'Name can contain only alphabets and spaces' AssertionError: Name can contain only alphabets and spaces

TDD7: Validate the input tax slab file, following conditions makes sense for now:

  1. All data in tax slab excel spreadsheet should be int apart from header.
  2. Data read from the tax slab should have only following static information:

low_band_income_range high_band_income_range tax_slab_rate 0 20000 0 20000 40000 10 40000 80000 20 80000 180000 30 180000 -1 40

  1. high_band_income_range for max tax bracket is -1, this is used only as a flag.

test cases are:

assert isinstance(int(eachTaxSlabRow[0]),int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int),'All data in Tax Slab file should be int apart from header row'
assert eachTaxSlabRow[0] >= 0 and eachTaxSlabRow[1] > 0 and eachTaxSlabRow[2] >= 0 , 'Lower income bracket and tax rate should be greater than or equal to 0. Upper income bracket should be greater than 0.'
expectedOutput = [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]]
assert entireTaxSlabWithoutMaximumIncome == expectedOutput,'Tax Slab does not match with expected output.'
assert maxSlabAnnualIncome == 180000 and maxSlabTaxRate == 40 , 'Maximum tax slab does not match with expected output'
assert validTaxSlabWithoutMaximumIncome and validTaxSlabMaximumIncome , 'Tax slab data is not valid'

So, the code which would facilitate the test conditions is:

def ValidateEachTaxSlab(eachTaxSlabRow): assert isinstance(int(eachTaxSlabRow[0]),int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int),'All data in Tax Slab file should be int apart from header row' assert eachTaxSlabRow[0] >= 0 and eachTaxSlabRow[1] > 0 and eachTaxSlabRow[2] >= 0 , 'Lower income bracket and tax rate should be greater than or equal to 0. Upper income bracket should be greater than 0.' return True

def ValidateTaxSlabWithoutMaximumIncome(entireTaxSlabWithoutMaximumIncome): expectedOutput = [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]] assert entireTaxSlabWithoutMaximumIncome == expectedOutput,'Tax Slab does not match with expected output.' return True

def ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome,maxSlabTaxRate): assert maxSlabAnnualIncome == 180000 and maxSlabTaxRate == 40 , 'Maximum tax slab does not match with expected output' return True

def ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome,validTaxSlabMaximumIncome): assert validTaxSlabWithoutMaximumIncome and validTaxSlabMaximumIncome , 'Tax slab data is not valid'

Looking at the code it appears that following test case is not required, because it would be covered by comparing the expected output of Tax slab in subsequent test cases: assert eachTaxSlabRow[0] >= 0 and eachTaxSlabRow[1] > 0 and eachTaxSlabRow[2] >= 0 , 'Lower income bracket and tax rate should be greater than or equal to 0. Upper income bracket should be greater than 0.'

So, now the code looks like: def ValidateEachTaxSlab(eachTaxSlabRow): assert isinstance(int(eachTaxSlabRow[0]),int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int),'All data in Tax Slab file should be int apart from header row' return True

def ValidateTaxSlabWithoutMaximumIncome(entireTaxSlabWithoutMaximumIncome): expectedOutput = [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]] assert entireTaxSlabWithoutMaximumIncome == expectedOutput,'Tax Slab does not match with expected output.' return True

def ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome,maxSlabTaxRate): assert maxSlabAnnualIncome == 180000 and maxSlabTaxRate == 40 , 'Maximum tax slab does not match with expected output' return True

def ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome,validTaxSlabMaximumIncome): assert validTaxSlabWithoutMaximumIncome and validTaxSlabMaximumIncome , 'Tax slab data is not valid'

Test results are: C:\Users\svishal\PycharmProjects\plutus>pytest ================================================================================================================================================================ test session starts ================================================================================================================================================================= platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 rootdir: C:\Users\svishal\PycharmProjects\plutus collected 4 items

tests\unit\test_u_app.py .... [100%]

================================================================================================================================================================= 4 passed in 0.11s ==================================================================================================================================================================

TDD8: Raise exception if tax slab file is not available. Test case is:

def test_tax_slab_file_exists(): assert os.path.isfile(os.getcwd() + '\GenerateMonthlyPayslip\StaticInput\tax_slab.csv'),'Tax slab file does not exists in specified folder'

Refactoring this test code to unit tests:

def test_calculate_tax(): assert GetAnnualTax(60000) == 6000, 'Tax calculation not correct'

def test_read_static_tax_file(): maxSlabAnnualIncome, maxSlabTaxRate, tax_slab_rate_list = ReadTaxFile() assert maxSlabAnnualIncome == 180000, 'Maximum Tax Slab annual income not correct' assert maxSlabTaxRate == 40, 'Maximum Tax Slab annual income not correct' assert tax_slab_rate_list == [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]] , 'Tax Slab rate is not correct'

def test_calculate_salary_details(): grossMonthlySalary, monthlyTaxPayable, netMonthlySalary=SalaryDetails(60000,6000) assert grossMonthlySalary == 5000, 'Gross monthly income not calculated correctly' assert monthlyTaxPayable == 500, 'Monthly tax payable not calculated correctly' assert netMonthlySalary == 4500, 'Net monthly salary not calculated correctly'

def test_print_employee_monthly_payslip(): employeeSelected = Employee('Mary Song',5000,500,4500) employeeSelected.PrintEmployeePayslip() expectedOutput = 'Monthly Payslip for: "Mary Song"\nGross Monthly Income: $5000\nMonthly Income Tax: $500\nNet Monthly Income: $4500' assert employeeSelected.PrintEmployeePayslip() == expectedOutput , 'Payslip output is not matching as expected'

def test_tax_slab_file_exists(): assert os.path.isfile(os.getcwd() + '\GenerateMonthlyPayslip\StaticInput\tax_slab.csv'),'Tax slab file does not exists in specified folder'

TDD9: Write the system integration test. Executing following command from the command prompt: python path_to_plutus\ GenerateMonthlyPayslip\app.py -efn "Mary Song" -gas=60000

Should give following result: Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500

Added following code as integration test to the project: import os,subprocess def test_system_integration_message(capsys): expectedOutput = 'Monthly Payslip for: "Mary Song"\r\nGross Monthly Income: $5000\r\nMonthly Income Tax: $500\r\nNet Monthly Income: $4500' testCmd='python ' + os.getcwd() + '\GenerateMonthlyPayslip\app.py -efn "Mary Song" -gas=60000' # os.system(testCmd) encoding = 'utf-8' result = subprocess.check_output(testCmd).decode(encoding) print(result) captured = capsys.readouterr() realOutput=captured.out.rstrip() print(captured) print(os.getcwd()) print('captured out is:') print(realOutput) print('expected out is:') print(expectedOutput) assert realOutput == expectedOutput , 'Expected output not observed. Integration test failed.'

Result of test: C:\Users\svishal\PycharmProjects\plutus>pytest -vv ================================================================================================================================================================ test session starts ================================================================================================================================================================= platform win32 -- Python 3.6.3, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 -- c:\program files (x86)\python36-32\python.exe cachedir: .pytest_cache rootdir: C:\Users\svishal\PycharmProjects\plutus collected 6 items

tests/integration/test_i_app.py::test_system_integration_message PASSED [ 16%] tests/unit/test_u_app.py::test_calculate_tax PASSED [ 33%] tests/unit/test_u_app.py::test_read_static_tax_file PASSED [ 50%] tests/unit/test_u_app.py::test_calculate_salary_details PASSED [ 66%] tests/unit/test_u_app.py::test_print_employee_monthly_payslip PASSED [ 83%] tests/unit/test_u_app.py::test_tax_slab_file_exists PASSED [100%]

================================================================================================================================================================= 6 passed in 0.23s ==================================================================================================================================================================

UC1: Parameterize config file name.

Added Linting:

First run: /usr/local/bin/pylint --rcfile=setup.cfg generate_monthly_payslip tests ************* Module plutus.generate_monthly_payslip generate_monthly_payslip/init.py:1:0: C0304: Final newline missing (missing-final-newline) ************* Module plutus.generate_monthly_payslip.logging_config generate_monthly_payslip/logging_config.py:6:0: C0304: Final newline missing (missing-final-newline) ************* Module plutus.generate_monthly_payslip.app generate_monthly_payslip/app.py:15:53: C0326: Exactly one space required after comma def GetEmployeeMonthlyIncomeDetails(grossAnnualSalary,annualTaxToBePaid): ^ (bad-whitespace) generate_monthly_payslip/app.py:16:42: C0326: Exactly one space required after comma return SalaryDetails(grossAnnualSalary,annualTaxToBePaid) ^ (bad-whitespace) generate_monthly_payslip/app.py:19:44: C0326: Exactly one space required after comma assert isinstance(int(grossAnnualSalary),int),'Gross Annual Salary is not int' ^ (bad-whitespace) generate_monthly_payslip/app.py:19:49: C0326: Exactly one space required after comma assert isinstance(int(grossAnnualSalary),int),'Gross Annual Salary is not int' ^ (bad-whitespace) generate_monthly_payslip/app.py:26:29: C0326: Exactly one space required after comma assert name.isalpha(),'Name can contain only alphabets and spaces' ^ (bad-whitespace) generate_monthly_payslip/app.py:30:24: C0326: Exactly one space required after comma def Run(employeeFullName,grossAnnualSalaryInput): ^ (bad-whitespace) generate_monthly_payslip/app.py:34:21: C0326: Exactly one space required around assignment grossAnnualSalary=ValidateConvertAnnualSalary(grossAnnualSalaryInput) ^ (bad-whitespace) generate_monthly_payslip/app.py:36:20: C0326: Exactly one space required around assignment annualTaxPayable=GetEmployeeAnnualTax(grossAnnualSalary) ^ (bad-whitespace) generate_monthly_payslip/app.py:38:93: C0326: Exactly one space required after comma grossMonthlySalary, monthlyTaxPayable, netMonthlySalary = SalaryDetails(grossAnnualSalary,annualTaxPayable) ^ (bad-whitespace) generate_monthly_payslip/app.py:40:20: C0326: Exactly one space required around assignment employeeSelected=Employee(employeeFullName,grossMonthlySalary, monthlyTaxPayable, netMonthlySalary) ^ (bad-whitespace) generate_monthly_payslip/app.py:40:46: C0326: Exactly one space required after comma employeeSelected=Employee(employeeFullName,grossMonthlySalary, monthlyTaxPayable, netMonthlySalary) ^ (bad-whitespace) generate_monthly_payslip/app.py:47:46: C0326: Exactly one space required after comma parser.add_argument('--employee-full-name','-efn', required=True, dest='employeeFullName', help='Full name of employee') ^ (bad-whitespace) generate_monthly_payslip/app.py:48:47: C0326: Exactly one space required after comma parser.add_argument('--gross-annual-salary','-gas', required=True, dest='grossAnnualSalary', help='gross annual salary of employee') ^ (bad-whitespace) generate_monthly_payslip/app.py:51:29: C0326: Exactly one space required after comma Run(args.employeeFullName,args.grossAnnualSalary) ^ (bad-whitespace) generate_monthly_payslip/app.py:52:0: C0305: Trailing newlines (trailing-newlines) generate_monthly_payslip/app.py:6:0: W0611: Unused import logging_config (unused-import) ************* Module plutus.generate_monthly_payslip.calculate_net_monthly_income_details generate_monthly_payslip/calculate_net_monthly_income_details.py:1:48: C0326: Exactly one space required after comma def CalculateNetMonthlyIncome(grossMonthlyIncome,netMonthlyTax): ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:10:35: C0326: Exactly one space required after comma def SalaryDetails(grossAnnualIncome,annualTaxToBePaid): ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:11:22: C0326: Exactly one space required around assignment grossMonthlySalary=CalculateGrossMonthlyIncome(grossAnnualIncome) ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:12:21: C0326: Exactly one space required around assignment monthlyTaxPayable=CalculateNetMonthlyTax(annualTaxToBePaid) ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:13:20: C0326: Exactly one space required around assignment netMonthlySalary=CalculateNetMonthlyIncome(grossMonthlySalary,monthlyTaxPayable) ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:13:65: C0326: Exactly one space required after comma netMonthlySalary=CalculateNetMonthlyIncome(grossMonthlySalary,monthlyTaxPayable) ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:14:29: C0326: Exactly one space required after comma return grossMonthlySalary,monthlyTaxPayable,netMonthlySalary ^ (bad-whitespace) generate_monthly_payslip/calculate_net_monthly_income_details.py:14:47: C0326: Exactly one space required after comma return grossMonthlySalary,monthlyTaxPayable,netMonthlySalary ^ (bad-whitespace) ************* Module plutus.generate_monthly_payslip.read_tax_slab generate_monthly_payslip/read_tax_slab.py:5:44: C0326: Exactly one space required after comma assert isinstance(int(eachTaxSlabRow[0]),int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int),'All data in Tax Slab file should be int apart from header row' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:5:137: C0326: Exactly one space required after comma assert isinstance(int(eachTaxSlabRow[0]),int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int),'All data in Tax Slab file should be int apart from header row' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:10:62: C0326: Exactly one space required after comma assert entireTaxSlabWithoutMaximumIncome == expectedOutput,'Tax Slab does not match with expected output.' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:13:52: C0326: Exactly one space required after comma def ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome,maxSlabTaxRate): ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:14:66: C0326: No space allowed before comma assert maxSlabAnnualIncome == 180000 and maxSlabTaxRate == 40 , 'Maximum tax slab does not match with expected output' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:17:58: C0326: Exactly one space required after comma def ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome,validTaxSlabMaximumIncome): ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:18:74: C0326: No space allowed before comma assert validTaxSlabWithoutMaximumIncome and validTaxSlabMaximumIncome , 'Tax slab data is not valid' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:27:22: C0326: Exactly one space required around assignment tax_slab_rate_list=[] ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:28:23: C0326: Exactly one space required around assignment maxSlabAnnualIncome=0 ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:29:18: C0326: Exactly one space required around assignment maxSlabTaxRate=0 ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:30:36: C0326: Exactly one space required around assignment validTaxSlabWithoutMaximumIncome=False ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:31:29: C0326: Exactly one space required around assignment validTaxSlabMaximumIncome=False ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:39:0: C0325: Unnecessary parens after 'if' keyword (superfluous-parens) generate_monthly_payslip/read_tax_slab.py:44:33: C0326: Exactly one space required around assignment tax_slab_list=[int(taxSlabRow[0]),int(taxSlabRow[1]),int(taxSlabRow[2])] ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:44:53: C0326: Exactly one space required after comma tax_slab_list=[int(taxSlabRow[0]),int(taxSlabRow[1]),int(taxSlabRow[2])] ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:44:72: C0326: Exactly one space required after comma tax_slab_list=[int(taxSlabRow[0]),int(taxSlabRow[1]),int(taxSlabRow[2])] ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:51:80: C0326: Exactly one space required after comma validTaxSlabMaximumIncome = ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome,maxSlabTaxRate) ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:52:58: C0326: Exactly one space required after comma ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome,validTaxSlabMaximumIncome) ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:54:30: C0326: Exactly one space required after comma return maxSlabAnnualIncome,maxSlabTaxRate,tax_slab_rate_list ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:54:45: C0326: Exactly one space required after comma return maxSlabAnnualIncome,maxSlabTaxRate,tax_slab_rate_list ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:57:0: C0304: Final newline missing (missing-final-newline) generate_monthly_payslip/read_tax_slab.py:46:11: W0703: Catching too general exception Exception (broad-except) generate_monthly_payslip/read_tax_slab.py:36:12: W0612: Unused variable 'header' (unused-variable) ************* Module plutus.generate_monthly_payslip.calculate_annual_tax generate_monthly_payslip/calculate_annual_tax.py:8:16: C0326: No space allowed after bracket def GetAnnualTax( annualIncome ): ^ (bad-whitespace) generate_monthly_payslip/calculate_annual_tax.py:8:31: C0326: No space allowed before bracket def GetAnnualTax( annualIncome ): ^ (bad-whitespace) generate_monthly_payslip/calculate_annual_tax.py:11:20: C0326: Exactly one space required after comma maxTaxSlabIncome,maxTaxSlabRate, taxSlabRanges = ReadTaxFile() ^ (bad-whitespace) generate_monthly_payslip/calculate_annual_tax.py:2:4: C0414: Import alias does not rename original package (useless-import-alias) generate_monthly_payslip/calculate_annual_tax.py:4:4: C0414: Import alias does not rename original package (useless-import-alias) ************* Module plutus.generate_monthly_payslip.print_employee_monthly_payslip generate_monthly_payslip/print_employee_monthly_payslip.py:9:28: C0326: Exactly one space required around assignment payslipOutputMessage='Monthly Payslip for: "' + self.__employeeFullName + '"\n' ^ (bad-whitespace) ************* Module plutus.tests.unit.test_u_app tests/unit/test_u_app.py:2:67: C0326: No space allowed before comma from ...generate_monthly_payslip.read_tax_slab import ReadTaxFile , GetCsvFilenameFromConfigFile ^ (bad-whitespace) tests/unit/test_u_app.py:14:110: C0326: No space allowed before comma assert tax_slab_rate_list == [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]] , 'Tax Slab rate is not correct' ^ (bad-whitespace) tests/unit/test_u_app.py:17:59: C0326: Exactly one space required around assignment grossMonthlySalary, monthlyTaxPayable, netMonthlySalary=SalaryDetails(60000,6000) ^ (bad-whitespace) tests/unit/test_u_app.py:17:79: C0326: Exactly one space required after comma grossMonthlySalary, monthlyTaxPayable, netMonthlySalary=SalaryDetails(60000,6000) ^ (bad-whitespace) tests/unit/test_u_app.py:23:43: C0326: Exactly one space required after comma employeeSelected = Employee('Mary Song',5000,500,4500) ^ (bad-whitespace) tests/unit/test_u_app.py:23:48: C0326: Exactly one space required after comma employeeSelected = Employee('Mary Song',5000,500,4500) ^ (bad-whitespace) tests/unit/test_u_app.py:23:52: C0326: Exactly one space required after comma employeeSelected = Employee('Mary Song',5000,500,4500) ^ (bad-whitespace) tests/unit/test_u_app.py:26:69: C0326: No space allowed before comma assert employeeSelected.PrintEmployeePayslip() == expectedOutput , 'Payslip output is not matching as expected' ^ (bad-whitespace) tests/unit/test_u_app.py:29:0: C0304: Final newline missing (missing-final-newline) tests/unit/test_u_app.py:29:94: C0326: Exactly one space required after comma assert os.path.isfile(os.getcwd() + '/generate_monthly_payslip/static_input/tax_slab.csv'),'Tax slab file does not exists in specified folder' ^ (bad-whitespace) tests/unit/test_u_app.py:1:0: C0414: Import alias does not rename original package (useless-import-alias) tests/unit/test_u_app.py:2:0: W0611: Unused GetCsvFilenameFromConfigFile imported from generate_monthly_payslip.read_tax_slab (unused-import) tests/unit/test_u_app.py:5:0: C0411: standard import "import os" should be placed before "from ...generate_monthly_payslip.calculate_annual_tax import GetAnnualTax as GetAnnualTax" (wrong-import-order) ************* Module plutus.tests.integration.test_i_app tests/integration/test_i_app.py:1:9: C0326: Exactly one space required after comma import os,subprocess ^ (bad-whitespace) tests/integration/test_i_app.py:10:11: C0326: Exactly one space required around assignment testCmd=["python3", os.getcwd() + '/generate_monthly_payslip/app.py', "-efn", "Mary Song", "-gas", "60000"] ^ (bad-whitespace) tests/integration/test_i_app.py:16:14: C0326: Exactly one space required around assignment realOutput=captured.out.rstrip() ^ (bad-whitespace) tests/integration/test_i_app.py:23:0: C0304: Final newline missing (missing-final-newline) tests/integration/test_i_app.py:23:40: C0326: No space allowed before comma assert realOutput == expectedOutput , 'Expected output not observed. Integration test failed.' ^ (bad-whitespace) tests/integration/test_i_app.py:1:0: C0410: Multiple imports on one line (os, subprocess) (multiple-imports)

Your code has been rated at 5.70/10

2nd run: /usr/local/bin/pylint --rcfile=setup.cfg generate_monthly_payslip tests ************* Module plutus.generate_monthly_payslip.app generate_monthly_payslip/app.py:30:24: C0326: Exactly one space required after comma def Run(employeeFullName,grossAnnualSalaryInput): ^ (bad-whitespace) generate_monthly_payslip/app.py:34:21: C0326: Exactly one space required around assignment grossAnnualSalary=ValidateConvertAnnualSalary(grossAnnualSalaryInput) ^ (bad-whitespace) generate_monthly_payslip/app.py:36:20: C0326: Exactly one space required around assignment annualTaxPayable=GetEmployeeAnnualTax(grossAnnualSalary) ^ (bad-whitespace) generate_monthly_payslip/app.py:51:29: C0326: Exactly one space required after comma Run(args.employeeFullName,args.grossAnnualSalary) ^ (bad-whitespace) generate_monthly_payslip/app.py:52:0: C0305: Trailing newlines (trailing-newlines) generate_monthly_payslip/app.py:6:0: W0611: Unused import logging_config (unused-import) ************* Module plutus.generate_monthly_payslip.calculate_net_monthly_income_details generate_monthly_payslip/calculate_net_monthly_income_details.py:13:67: C0326: Exactly one space required after comma netMonthlySalary = CalculateNetMonthlyIncome(grossMonthlySalary,monthlyTaxPayable) ^ (bad-whitespace) ************* Module plutus.generate_monthly_payslip.read_tax_slab generate_monthly_payslip/read_tax_slab.py:5:44: C0326: Exactly one space required after comma assert isinstance(int(eachTaxSlabRow[0]),int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int), 'All data in Tax Slab file should be int apart from header row' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:14:66: C0326: No space allowed before comma assert maxSlabAnnualIncome == 180000 and maxSlabTaxRate == 40 , 'Maximum tax slab does not match with expected output' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:18:74: C0326: No space allowed before comma assert validTaxSlabWithoutMaximumIncome and validTaxSlabMaximumIncome , 'Tax slab data is not valid' ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:39:0: C0325: Unnecessary parens after 'if' keyword (superfluous-parens) generate_monthly_payslip/read_tax_slab.py:51:80: C0326: Exactly one space required after comma validTaxSlabMaximumIncome = ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome,maxSlabTaxRate) ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:52:58: C0326: Exactly one space required after comma ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome,validTaxSlabMaximumIncome) ^ (bad-whitespace) generate_monthly_payslip/read_tax_slab.py:57:0: C0304: Final newline missing (missing-final-newline) generate_monthly_payslip/read_tax_slab.py:46:11: W0703: Catching too general exception Exception (broad-except) generate_monthly_payslip/read_tax_slab.py:36:12: W0612: Unused variable 'header' (unused-variable) ************* Module plutus.generate_monthly_payslip.calculate_annual_tax generate_monthly_payslip/calculate_annual_tax.py:8:16: C0326: No space allowed after bracket def GetAnnualTax( annualIncome ): ^ (bad-whitespace) generate_monthly_payslip/calculate_annual_tax.py:8:31: C0326: No space allowed before bracket def GetAnnualTax( annualIncome ): ^ (bad-whitespace) generate_monthly_payslip/calculate_annual_tax.py:2:4: C0414: Import alias does not rename original package (useless-import-alias) generate_monthly_payslip/calculate_annual_tax.py:4:4: C0414: Import alias does not rename original package (useless-import-alias) ************* Module plutus.tests.unit.test_u_app tests/unit/test_u_app.py:17:81: C0326: Exactly one space required after comma grossMonthlySalary, monthlyTaxPayable, netMonthlySalary = SalaryDetails(60000,6000) ^ (bad-whitespace) tests/unit/test_u_app.py:29:0: C0304: Final newline missing (missing-final-newline) tests/unit/test_u_app.py:1:0: C0414: Import alias does not rename original package (useless-import-alias) tests/unit/test_u_app.py:5:0: C0411: standard import "import os" should be placed before "from ...generate_monthly_payslip.calculate_annual_tax import GetAnnualTax as GetAnnualTax" (wrong-import-order) ************* Module plutus.tests.integration.test_i_app tests/integration/test_i_app.py:1:9: C0326: Exactly one space required after comma import os,subprocess ^ (bad-whitespace) tests/integration/test_i_app.py:1:0: C0410: Multiple imports on one line (os, subprocess) (multiple-imports)

Your code has been rated at 8.49/10 (previous run: 5.70/10, +2.79)

3rd run: ************* Module plutus.generate_monthly_payslip.app generate_monthly_payslip/app.py:6:0: W0611: Unused import logging_config (unused-import) ************* Module plutus.generate_monthly_payslip.read_tax_slab generate_monthly_payslip/read_tax_slab.py:46:11: W0703: Catching too general exception Exception (broad-except) generate_monthly_payslip/read_tax_slab.py:36:12: W0612: Unused variable 'header' (unused-variable)

Your code has been rated at 9.83/10 (previous run: 8.49/10, +1.34)

Bug1: When using flask or other code outside the folder hosting read_tax_slab.py, it throws following error: INFO:generate_monthly_payslip.app:Welcome to the world of "Plutus". Starting payslip generator application. Traceback (most recent call last): File "/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/app.py", line 49, in Run(args.employeeFullName, args.grossAnnualSalary) File "/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/app.py", line 34, in Run annualTaxPayable = GetEmployeeAnnualTax(grossAnnualSalary) File "/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/app.py", line 13, in GetEmployeeAnnualTax return GetAnnualTax(grossAnnualSalary) File "/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/calculate_annual_tax.py", line 8, in GetAnnualTax maxTaxSlabIncome, maxTaxSlabRate, taxSlabRanges = ReadTaxFile() File "/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/read_tax_slab.py", line 51, in ReadTaxFile validTaxSlabWithoutMaximumIncome = ValidateTaxSlabWithoutMaximumIncome(tax_slab_rate_list) File "/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/read_tax_slab.py", line 10, in ValidateTaxSlabWithoutMaximumIncome assert entireTaxSlabWithoutMaximumIncome == expectedOutput, 'Tax Slab does not match with expected output.' AssertionError: Tax Slab does not match with expected output.

Analysis: We are getting into this issue, because we are trying to get the absolute path of the tax_slab.csv file. The line which is faulting is: def ReadTaxFile(): inputStaticTaxSlabFile = os.path.abspath('static_input') + '/tax_slab.csv'

Changing it to Python 3.6 pythonic way should fix it. Pseudo code could be: from pathlib import Path

inputStaticTaxSlabFile = Path(file).parent / "static_input/tax_slab.csv"

Refactoring the code: import csv import os from pathlib import Path

def ValidateEachTaxSlab(eachTaxSlabRow): assert isinstance(int(eachTaxSlabRow[0]), int) and isinstance(int(eachTaxSlabRow[1]), int) and isinstance(int(eachTaxSlabRow[2]), int), 'All data in Tax Slab file should be int apart from header row' return True

def ValidateTaxSlabWithoutMaximumIncome(entireTaxSlabWithoutMaximumIncome): expectedOutput = [[0, 20000, 0], [20000, 40000, 10], [40000, 80000, 20], [80000, 180000, 30]] assert entireTaxSlabWithoutMaximumIncome == expectedOutput, 'Tax Slab does not match with expected output.' return True

def ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome, maxSlabTaxRate): assert maxSlabAnnualIncome == 180000 and maxSlabTaxRate == 40, 'Maximum tax slab does not match with expected output' return True

def ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome, validTaxSlabMaximumIncome): assert validTaxSlabWithoutMaximumIncome and validTaxSlabMaximumIncome, 'Tax slab data is not valid'

def GetCsvFilenameFromConfigFile(): configFileWithLocation = "../setup_config" with open(configFileWithLocation, "r") as configFile: return configFile.readline().split('=')[1]

def ReadTaxFile(): inputStaticTaxSlabFile = Path(file).parent / "static_input/tax_slab.csv" print (inputStaticTaxSlabFile) tax_slab_rate_list = [] maxSlabAnnualIncome = 0 maxSlabTaxRate = 0 validTaxSlabWithoutMaximumIncome = False validTaxSlabMaximumIncome = False

try:
    with open(inputStaticTaxSlabFile) as csvfile:
        csv_file = csv.reader(csvfile)
        header = next(csv_file)
        taxSlab = csv_file
        for taxSlabRow in taxSlab:
            if taxSlabRow[1] == '-1':
                maxSlabAnnualIncome = int(taxSlabRow[0])
                maxSlabTaxRate = int(taxSlabRow[2])
            else:
                ValidateEachTaxSlab(taxSlabRow)
                tax_slab_list = [int(taxSlabRow[0]), int(taxSlabRow[1]), int(taxSlabRow[2])]
                tax_slab_rate_list.append(tax_slab_list)
except Exception as exception:
    print("File not accessible")
    print(format(exception))

validTaxSlabWithoutMaximumIncome = ValidateTaxSlabWithoutMaximumIncome(tax_slab_rate_list)
validTaxSlabMaximumIncome = ValidateTaxSlabMaximumIncome(maxSlabAnnualIncome, maxSlabTaxRate)
ValidateEntireTaxSlab(validTaxSlabWithoutMaximumIncome, validTaxSlabMaximumIncome)

return maxSlabAnnualIncome, maxSlabTaxRate, tax_slab_rate_list

if name == 'main': ReadTaxFile()

Reran unit tests: Integration test failed after this fix:

  assert realOutput == expectedOutput, 'Expected output not observed. Integration test failed.'

E AssertionError: Expected output not observed. Integration test failed. E assert "['python3', ...Income: $4500" == "['python3', ...Income: $4500" E ['python3', '/home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/app.py', '-efn', 'Mary Song', '-gas', '60000'] E - /home/svishal/git-repos/generate_payslip/plutus/generate_monthly_payslip/static_input/tax_slab.csv E Monthly Payslip for: "Mary Song" E Gross Monthly Income: $5000 E Monthly Income Tax: $500 E Net Monthly Income: $4500

tests/integration/test_i_app.py:24: AssertionError

It seems that the tax file name is getting printed as highlighted above. This is occurring because we added a step to print the tax_slab.csv file path to troubleshoot! So, offending code is: def ReadTaxFile(): inputStaticTaxSlabFile = Path(file).parent / "static_input/tax_slab.csv" print (inputStaticTaxSlabFile) tax_slab_rate_list = [] maxSlabAnnualIncome = 0 maxSlabTaxRate = 0 validTaxSlabWithoutMaximumIncome = False validTaxSlabMaximumIncome = False

Removing the print statement should fix it. Refactored code. Now the integration tests succeeds but api is not giving desired output:

tests/unit/test_u_app.py::test_calculate_tax PASSED [ 12%] tests/unit/test_u_app.py::test_read_static_tax_file PASSED [ 25%] tests/unit/test_u_app.py::test_calculate_salary_details PASSED [ 37%] tests/unit/test_u_app.py::test_print_employee_monthly_payslip PASSED [ 50%] tests/unit/test_u_app.py::test_tax_slab_file_exists PASSED [ 62%] tests/unit/test_u_app.py::test_if_api_is_running PASSED [ 75%] tests/unit/test_u_app.py::test_if_api_gives_expected_output FAILED [ 87%] tests/integration/test_i_app.py::test_system_integration_message PASSED [100%]

The error message is:

  assert response.content == expectedOutput, 'API is not giving expected output'

E AssertionError: API is not giving expected output E assert b'Monthly Pay...come: $4500\n' == 'Monthly Pays...Income: $4500' E -b'Monthly Payslip for: "Mary Song"\nGross Monthly Income: $5000\nMonthly Income Tax: $500\nNet Monthly Income: $4500\n' E +'Monthly Payslip for: "Mary Song"\nGross Monthly Income: $5000\nMonthly Income Tax: $500\nNet Monthly Income: $4500'

tests/unit/test_u_app.py:42: AssertionError

So, we are comparing byte string with normal string. The offending code is: def test_if_api_gives_expected_output(): expectedOutput = '''Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500''' response = requests.get('http://127.0.0.1:5000/api/v1/resources/employee?fullName=Mary%20Song&grossAnnualIncome=60000') assert response.content == expectedOutput, 'API is not giving expected output'

So, response.content should be encoded to compare. Refactored the code to following: def test_if_api_gives_expected_output(): expectedOutput = '''Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500''' response = requests.get('http://127.0.0.1:5000/api/v1/resources/employee?fullName=Mary%20Song&grossAnnualIncome=60000') encoding = 'utf-8' assert response.content.decode(encoding) == expectedOutput, 'API is not giving expected output'

Running tests again, it still failed:

  assert response.content.decode(encoding) == expectedOutput, 'API is not giving expected output'

E AssertionError: API is not giving expected output E assert 'Monthly Pays...come: $4500\n' == 'Monthly Pays...Income: $4500' E Monthly Payslip for: "Mary Song" E Gross Monthly Income: $5000 E Monthly Income Tax: $500 E - Net Monthly Income: $4500 E ? - E + Net Monthly Income: $4500

So, it is occurring because expected output does not have a new line character. Changing test case to use valid expected output should fix it.

So, now the test looks like: def test_if_api_gives_expected_output(): expectedOutput = '''Monthly Payslip for: "Mary Song" Gross Monthly Income: $5000 Monthly Income Tax: $500 Net Monthly Income: $4500 ''' response = requests.get('http://127.0.0.1:5000/api/v1/resources/employee?fullName=Mary%20Song&grossAnnualIncome=60000') encoding = 'utf-8' assert response.content.decode(encoding) == expectedOutput, 'API is not giving expected output'

Running tests again, and voila it succeeds: ================================================================================ test session starts ================================================================================= platform linux -- Python 3.6.0, pytest-5.3.5, py-1.8.1, pluggy-0.13.1 -- /usr/local/bin/python3.6 cachedir: .pytest_cache rootdir: /home/svishal/git-repos/generate_payslip/plutus, inifile: setup.cfg, testpaths: tests/unit, tests/integration collected 8 items

tests/unit/test_u_app.py::test_calculate_tax PASSED [ 12%] tests/unit/test_u_app.py::test_read_static_tax_file PASSED [ 25%] tests/unit/test_u_app.py::test_calculate_salary_details PASSED [ 37%] tests/unit/test_u_app.py::test_print_employee_monthly_payslip PASSED [ 50%] tests/unit/test_u_app.py::test_tax_slab_file_exists PASSED [ 62%] tests/unit/test_u_app.py::test_if_api_is_running PASSED [ 75%] tests/unit/test_u_app.py::test_if_api_gives_expected_output PASSED [ 87%] tests/integration/test_i_app.py::test_system_integration_message PASSED [100%]

================================================================================= 8 passed in 0.23s ==================================================================================