[[Category:OPS435-Python]][[Category:rchan]]
<font color='red'>'''DRAFT - Under Construction'''</font>
=Assignment 1 - Usage Report=
'''Weight:''' 2015% of the overall grade
'''Due Date:''' Ask your professor for exact date
==Overview==
Most system administrators would like to know the utilization of their systems by their users. On a Linux system, each user's login records are normally stored in the binary file /var/log/wtmp. The login record in this binary file can not be viewed or edited directly using normal Linux text commands like 'less', 'cat', etc. The 'last' command is often used to display the login records stored in this file in a human readable form. Please check the man page of the 'last' command for available options. The following listing is a sample output of the 'last' commandwith the '-F' flag on:
<pre>
$ last -F
</pre>
In this assignment, your task is to create a python program with well designed functions to produce daily, weekly, and monthly usage reports by user or by remote host based on the information obtained from the 'last' command or given files which contain similar information as the 'last' command.
== Resource for useful modules ==
* the <b>argparse</b> module
** [https://docs.python.org/3/howto/argparse.html Argparse Tutorial] - should read this first.
** [https://docs.python.org/3/library/argparse.html Argparse API reference information page]
* the <b>time</b> module
** [https://www.tutorialspoint.com/python3/python_date_time.htm Time module Tutorial]
** [https://docs.python.org/3/library/time.html Time module API reference page]
== Instructions ==
=== Program Name and valid command line arguments ===
Name your Python3 program as <code>usage_reportur.py</code>. The program should accept zero one or more "file name" as as its command line parametersand other optional parameters as shown below. for examplesYour ur.py script should produce the following usage when run with the --help option:* <pre>[rchan@centos7 a1]$ python3 usage_report./ur.py, or-h* python3 usage_reportusage: ur.py <b><code>filename</code></b>[-h] [-l {user,host}] [-r RHOST] [-t {daily,weekly, ormonthly}] [-u USER] [-v]* python3 usage_report.py <b><code>filename1 filename2 </code></b> etc F [F ... ] Usage Report based on the last command positional arguments: F list of files to be processed optional arguments: -h, --help show this help message and exit -l {user,host}, --list {user,host} generate user name or remote host IP from the given files -r RHOST, --rhost RHOST usage report for the given remote host IP -t {daily,weekly,monthly}, -- any number type {daily,weekly,monthly} type of filenames from 1 to as many as report: daily, weekly, and monthly -u USER, --user USER usage report for the commandgiven user name -v, --verbose tune on output verbosity Copyright 2018 -Raymond Chan </pre>Replace the last line supports.with your own full name
If there one of the file name given is no command line argument"last", your python program should get the login records from the 'last' command with the appropriate flags.
If there is one filename file name provided at the command line, gets read the login records from the contents of the given file. The format of each line in the file should be the same as the output of 'last -FFiw'.
If there is more than one filename file name provided, merges all the files together with the first one at the top and the last one at the bottom. Read and process the file contents in that order in your program.
=== Header ===
All your Python codes for this program must be placed in a <font color='red'><b><u>single source file</u></b></font>. Please include the following declaration by <b><u>you </u></b> as comment in your Python source code file (replace "Student Name" with your own name):
<source>OPS435 Assignment 1 - Winter Summer 2018Program: usage_reportur.py
Author: "Student Name"
The python code in this file (usage_reportur.py) is original work written by
"Student Name". No code in this file is copied from any other source
including any person, textbook, or on-line resource. I have not shared
</source>
=== Main Menu ===
When your Python program is running, it should present the user with the following menus:
<source>Reading login records... Done.
Usage Report - Main Menu
========================
d) Daily Usage Report
w) Weekly Usage Report
m) Monthly Usage Report
q) Quit
</source>
Option <b>d</b>, <b>w</b>, and <b>m</b> when selected will display a new sub-menu.
When option <b>q</b> is selected, you program should terminate.
=== Daily Usage Menu ===
* If the Daily Usage Report option is selected from the Main Menu, the following sub-menu should be presented on the screen:
<source>
Daily Usage Report Menu
=======================
u) By User
h) By Remote Host
r) Return to Main Menu
</source>
When option <b>u</b> is selected, the sub-menu for Daily Usage Report by User should be displayed.
When option <b>h</b> is selected, the sub-menu for Daily Usage Report by Remote Host should be displayed.
When option <b>r</b> is selected, the main menu should be displayed.
==== Daily Usage Report by User ====
The following is a sample Daily Usage Report for user1 on host.cty.senecacollege.ca:<sourcepre>Daily Usage Report - by Userfor user1
============================
List of valid users:user1 user2 user3 user4 ......r) Return to Daily Usage Report Menu</source> <b>Valid user</b> is regular user (super user and system users should not be included) who are allowed to login to the system. When option <b>r</b> is selected, the Daily Usage Report menu should be displayed. When a <b>valid user</b> is selected, the Daily Usage Report for the selected user should be generated. The following is a sample Daily Usage Report for user1 on host.cty.senecacollege.ca:<pre>Daily Usage Report for user1 on host.cty.senecacollege.ca=========================================================Date Usage in Minutesseconds2018-02-14 602018-02-07 452018-02-01 5
Total 110
==== Daily Usage Report by Remote Host====
<source>Daily Usage Report - by Remote Host===================================Valid Remote Host:10.94.10.2510.94.10.120172.16.99.1192.168.45.3...r) Return to Daily Usage Report Menu</source> <b>Valid Remote Host</b> is any host that any <b>valid user</b> used to login to the system. When option <b>r</b> is selected, the Daily Usage Report menu should be displayed. When a <b>valid Remote Host</b> is selected, the Daily Usage Report for the selected Remote Host should be generated. The following is a sample Daily Usage Report from Remote Host 10.94.10.25 on host.cty.senecacollege.ca:
<pre>
Daily Usage Report from 10.94.10.25 on host.cty.senecacollege.ca================================================================Date Usage in Minutesseconds2018-02-14 302018-02-07 412018-02-01 9
Total 80
</pre>
=== Weekly Usage Menu ===
* If the Weekly Usage Report option is selected from the Main Menu, the following sub-menu should be presented on the screen:
<source>
Weekly Usage Report Menu
========================
u) By User
h) By Remote Host
r) Return to Main Menu
</source>
When option <b>u</b> is selected, the sub-menu for Weekly Usage Report by User should be displayed.
When option <b>h</b> is selected, the sub-menu for Weekly Usage Report by Remote Host should be displayed.
When option <b>r</b> is selected, the main menu should be displayed.
==== Weekly Usage Report by User ====
<source>
Weekly Usage Report - by User
=============================
Valid Users:
User1 User2 User3 ...
...
r) Return to Weekly Usage Report Menu
</source>
When option <b>r</b> is selected, the Weekly Usage Report menu should be displayed.
When a <b>valid user</b> is selected, the Weekly Usage Report for the selected user should be generated from week 1 to week 52, if the weekly usage is zero, skips the week.
The following is a sample Weekly Usage Report for user1 on host.cty.senecacollege.ca:
<pre>
Weekly Usage Report for user1 on host.cty.senecacollege.ca=========================================================Week # Usage in MinutesSeconds1 2017 01 1602 2017 02 453 2017 03 54 2017 04 20
Total 220
==== Weekly Usage Report by Remote Host ====
<source>
Weekly Usage Report - by Remote Host
===================================
Valid Remote Hosts:
10.94.10.25
10.94.10.120
172.16.99.1
192.168.45.3
...
r) Return to Weekly Usage Report Menu
</source>
When option <b>r</b> is selected, the Weekly Usage Report menu should be displayed.
When a <b>valid Remote Host</b> is selected, the Weekly Usage Report for the selected Remote Host should be generated from week 1 to week 52, if the weekly usage is zero, skips the week.
The following is a sample Weekly Usage Report from the remote host 10.94.10.25 on host.cty.senecacollege.ca:
<pre>
Daily Weekly Usage Report from 10.94.10.25 on host.cty.senecacollege.ca================================================================Week # Usage in MinutesSeconds1 2017 01 303 2017 03 415 2017 05 96 2017 06 11
Total 91
</pre>
==== Monthly Usage Menu Report by User ====* If the The following is a sample Monthly Usage Report option is selected from the Main Menu, the following sub-menu should be presented for user1 on the screenhost.cty.senecacollege.ca:<pre>Monthly Usage Report for user1==============================Month Usage in Seconds2017 01 1602017 02 45
<source>Monthly Usage Report Menu=========================u) By Userh) By Remote Hostr) Return to Main MenuTotal 205</sourcepre>
When option <b>u</b> ==== Monthly Usage Report by Remote Host ====The following is selected, the sub-menu for a sample Monthly Usage Report by User should be displayedfor 10.94.10.25 on host.cty.senecacollege.ca:
When option <bpre>h</b> is selected, the sub-menu for Monthly Usage Report by Remote Host should be displayedfrom 10.94.10.25=====================================Month Usage in Seconds2017 01 302017 02 41
When option <b>rTotal 71</bpre> is selected, the main menu should be displayed.
<source>Monthly Usage Report - by User============================Program Development and Testing ==...You should create python functions to handle the following sub-tasks:Display list * gets login records from the output of valid "last" command and filters out unwanted records* reads login records from files and filters out unwanted records* generate daily usage reports by useror by remote host...* generate weekly usage reports by user or by remote hostr) Return to Monthly * generate monthly usage reports by user or by remote hostTo help you with this assignment, [[OPS435 A1 Usage Report Menu</source>When Template|here is a template]] you can use as a <b>valid user</b> is selected, display the Weekly starting point in developing your Python Usage Report for the selected userprogram.
When option <b>r</b> is selectedOnce you have finished coding a function, you should start a Python3 interactive shell, import your functions and manually call the Weekly Usage Report menu should be displayedfunction you want to test.
<source>Monthly Usage Report - Once you have all the individual function tested and that each is working properly, perform the final test with test data provided by Remote Host=====================================your professor and verify that your program produces the correct results before submitting your python program on Blackboard...Display list of valid Remote Host...r) Return to Monthly Usage Report Menu</source>
When a <b>valid Remote Host<== Sample login records file and sample run ==* [https:/b> is selected, display the Monthly Usage Report for the selected Remote Host/scs.senecac.on.ca/~raymond.chan/ops435/a1/ Sample test date files and sample runs]
== Rubric ==
When option <b>r</b> is selected, the {| class="wikitable" border="1"! Task !! Maximum mark !! Actual mark|-| Program Authorship Declaration ||1 |||-| Program usage || 2 |||-| Program Options || 2 |||-| Daily Usage Report by User || 2 |||-| Daily Usage Report by Remote Host || 2 |||-| Weekly Usage Report by User || 2 |||-| Weekly Usage Report by Remote Host || 2 |||-| Monthly Usage Report by User || 2 |||-| Monthly Usage Report menu should be displayed.by Remote Host || 2 |||-| Get Login Records from 'last' || 2 |||-| Get Login Records from files || 2 |||-| Generate user name list || 2 |||-| Generate remote host IP list|| 2 || |-| '''Total''' || 25 ||
== Sample login records file ==|}
== Submission ==
After fully testing your program, submit the your ur.py file on Blackboard
