Difference between revisions of "OPS435 Online Assignment 2S"
(→Sample outputs from running your Fabric task file) |
|||
| Line 108: | Line 108: | ||
Disconnecting from myvmlab.senecacollege.ca:7598... done. | Disconnecting from myvmlab.senecacollege.ca:7598... done. | ||
</pre> | </pre> | ||
| + | == Suggested work-flow for this assignment == | ||
| + | === create a <font color="blue">private</font> repository on github === | ||
| + | * Use the same github account you used for your assignment 1 repository. | ||
| + | * Create a private repository named "ops435-a2r" for this assignment. | ||
| + | * Populate your private repository with appropriate files. Please check out the sample repository <b><font color='blue'>[https://github.com/rayfreeping/ops435-a2 here]</font></b> | ||
| + | |||
| + | === Add collaborator to your ops435-a2r private repository === | ||
| + | * Add your professor's github account as one of the collaborators to your ops435-a2r private repository. This will allow your professor to pull the contents of your ops435-a2r repository and also to review and suggest changes and fixes to your algorithm and/or python script. | ||
| + | * <b><font color='blue'>Make sure that your professor accepted your invitation from github.com.</font></b> | ||
| + | |||
| + | === Detail Algorithm Document === | ||
| + | Follow the standard computation procedure: input - process - ouput when creating the algorithm document for this assignment. | ||
| + | ==== input ==== | ||
| + | * get data (command line arguments/options) from the user using the functions provided by the argparse module | ||
| + | * according to the arguments/options given at the command line, take appropriate processing action. | ||
| + | ==== processing ==== | ||
| + | * based on the file(s) specified, read the contents of each file and use appropriate objects to store it | ||
| + | * based on the command line arguments/options, process the data accordingly, which includes | ||
| + | ** data preprocessing (split a multi-day record into single day record) | ||
| + | ** record processing (preform required computation) | ||
| + | ==== output ==== | ||
| + | * output the required report based on the processed data | ||
| + | ==== identify and select appropriate python objects and functions ==== | ||
| + | The following python functions (to be created, you may have more) are useful in handling the following sub-tasks: | ||
| + | * reads login records from files and filters out unwanted records | ||
| + | * convert login records into proper python object type so that it can be processed using as much built-in functions as possible | ||
| + | * create function which generates daily usage reports by user and/or by remote host | ||
| + | * create function which generates weekly usage reports by user and/or by remote host | ||
| + | |||
| + | To help you with this assignment, you can use the ur_template.py in the sample ops435-a2 repository as a starting point in designing your own Python Usage Report script. | ||
| + | <font color='blue'><b>If you don't have enough time to create all the functions for the data processing steps, you should study the functions in the ur_funcs.py (provided by your teacher), pick and use the one that may help. </b></font> | ||
| + | |||
| + | === Python script coding and debugging === | ||
| + | For each function, identify what type of objects should be passed to the function, and what type of objects should be returned to the caller. | ||
| + | Once you have finished coding a function, you should start a Python3 interactive shell, import your functions and manually test each function and verify its correctness. | ||
| + | === Final Test=== | ||
| + | Once you have all the individual function tested and that each is working properly, perform the final test with test data provided by your professor and verify that your script produces the correct results before submitting your python program on Blackboard. Upload all the files for this assignment 2 to your vm in myvmlab and perform the final test. | ||
| + | |||
| + | == Sample login/logout records file and sample test run results== | ||
| + | * can be found from the sample repository github.com/rayfreeping/ops435-a2 | ||
| + | |||
| + | == Rubric == | ||
| + | |||
| + | {| class="wikitable" border="1" | ||
| + | ! Task !! Maximum mark !! Actual mark | ||
| + | |- | ||
| + | | User Requirement Document||20 || | ||
| + | |- | ||
| + | | Program usage and Options || 20 || | ||
| + | |- | ||
| + | | Generate user name list || 10 || | ||
| + | |- | ||
| + | | Generate remote host IP list|| 10 || | ||
| + | |- | ||
| + | | Daily Usage Report by User || 10 || | ||
| + | |- | ||
| + | | Daily Usage Report by Remote Host || 10 || | ||
| + | |- | ||
| + | | Weekly Usage Report by User || 10 || | ||
| + | |- | ||
| + | | Weekly Usage Report by Remote Host || 10 || | ||
| + | |- | ||
| + | |||
| + | | '''Total''' || 100 || | ||
| + | |||
| + | |} | ||
| + | |||
| + | == Submission == | ||
| + | * Stage 1: upload your algorithm document file to your ops435-a2r repository in github.com by November 25, 2020 | ||
| + | * Stage 2: upload your python script for this assignment to your ops435-a2r repository in github.com and to your vm in myvmlab by Dec 2, 2020 | ||
| + | * Stage 3: After fully tested and debugged your python script for this assignment, update your algorithm, your python script, and your est results to your ops435-a2r repository in github.com. Also submit the algorithm document, the python script and final test result to blackboard by Dec 4, 2020 | ||
Revision as of 07:13, 19 November 2020
Contents
- 1 Assignment 2 S - Create Fabric tasks for remote User Management
- 1.1 Overview
- 1.2 Tasks for this assignment
- 1.3 Sample outputs from running your Fabric task file
- 1.4 Suggested work-flow for this assignment
- 1.5 Sample login/logout records file and sample test run results
- 1.6 Rubric
- 1.7 Submission
Assignment 2 S - Create Fabric tasks for remote User Management
Weight: 15% of the overall grade
What you need
- A github account with a private repository named ops435-a2s
- Complete Lab 8
- A VM assigned to you on myvmlab.senecacollege.ca by Seneca ITS.
- Has access to matrix.senecacollege.ca
Due Date: Please follow the three stages of submission schedule:
- Check point 1: complete the detail algorithm for each task in this assignment by November 25, 2020. Name it as a2s_algorithm.txt and upload it to your github repository
- Check point 2: complete the coding of your fabric commands file from the algorithm for each task by Dec 2, 2020. Name it as a2s_[Seneca_name].py (replace [Seneca_name] with your Seneca email user name) and upload it to your github repo by Dec 2, 2020.
- Check point 3: complete the testing and debugging using your VM in myvmlab by Dec 4, and also submit your algorithm file (a2s_algorithm.txt), test results, and the fabric file (a2s_[Seneca_name].py) to Blackboard.
Late Penalty: 20% per school day, and note that in order to pass this course, this assignment must be completed satisfactorily, i.e. a grade of 50% or more.
Overview
- Study the Fabric API run(), sudo(), local(), and put() and utilize them to create a new Fabric task called userAdmin()
- The userAdmin() task should perform the following activities on a remote machine to:
- create a new user when necessary information is provided
- delete an existing user when it is safe to do so.
Tasks for this assignment
In this assignment, you should perform the following activities:
- Complete a detail algorithm for the following FOUR system administrator operations:
- add a user account to a Linux system (task name addUser)
- determine whether a given user name exist on a Linux system (task name findUser)
- get a list of user account name with a command shell on a Linux system (listUser)
- get a list of system account name without a command shell on a Linux system (listSysUser)
- Create a corresponding fabric task using the fabric API to automate the above four system administrator operations.
- Test and debug your fabric file using your assigned VM in myvmlab.senecacollege.ca
Sample outputs from running your Fabric task file
Name of fabric file: a2s_rchan.py
list of fabric commands
[raymond.chan@mtrx-node05pd lab8]$ fab -f a2s_rchan.py -l
Available commands:
addUser add a user with given user name to remote system
findUser find user with a given user name
listSysUser return a list of system (non-shell) user
listUser return a list of shell user on a remote system
Test run the addUser task
[raymond.chan@mtrx-node05pd lab8]$ fab -f faba2.py --host=myvmlab.senecacollege.ca --port=7598 addUser:ops435 [myvmlab.senecacollege.ca] Executing task 'addUser' [myvmlab.senecacollege.ca] ... Done. Disconnecting from myvmlab.senecacollege.ca:7598... done.
Test run the findUser task
[raymond.chan@mtrx-node05pd lab8]$ fab -f faba2.py --host=myvmlab.senecacollege.ca --port=7598 findUser:ops435 [myvmlab.senecacollege.ca] Executing task 'findUser' ... ... [myvmlab.senecacollege.ca] out: Found user ops435 on the system. Done. Disconnecting from myvmlab.senecacollege.ca:7598... done.
Another test run:
[raymond.chan@mtrx-node05pd lab8]$ fab -f faba2.py --host=myvmlab.senecacollege.ca --port=7598 findUser:seneca [myvmlab.senecacollege.ca] Executing task 'findUser' ... ... [myvmlab.senecacollege.ca] out: User seneca is not on the system. Done. Disconnecting from myvmlab.senecacollege.ca:7598... done.
Test run the listUser task
[raymond.chan@mtrx-node05pd lab8]$ fab -f faba2.py --host=myvmlab.senecacollege.ca --port=7598 listUser [myvmlab.senecacollege.ca] Executing task 'listUser' ... ... ['root', 'raymond', 'chan', 'ops435'] Done. Disconnecting from myvmlab.senecacollege.ca:7598... done.
Test run the listSysUser task
[raymond.chan@mtrx-node05pd lab8]$ fab -f faba2.py --host=myvmlab.senecacollege.ca --port=7598 listSysUser [myvmlab.senecacollege.ca] Executing task 'listSysUser' ... ... [myvmlab.senecacollege.ca] out: ['bin', 'daemon', ... 'postfix', 'chrony', 'ntp'] Done. Disconnecting from myvmlab.senecacollege.ca:7598... done.
Suggested work-flow for this assignment
create a private repository on github
- Use the same github account you used for your assignment 1 repository.
- Create a private repository named "ops435-a2r" for this assignment.
- Populate your private repository with appropriate files. Please check out the sample repository here
Add collaborator to your ops435-a2r private repository
- Add your professor's github account as one of the collaborators to your ops435-a2r private repository. This will allow your professor to pull the contents of your ops435-a2r repository and also to review and suggest changes and fixes to your algorithm and/or python script.
- Make sure that your professor accepted your invitation from github.com.
Detail Algorithm Document
Follow the standard computation procedure: input - process - ouput when creating the algorithm document for this assignment.
input
- get data (command line arguments/options) from the user using the functions provided by the argparse module
- according to the arguments/options given at the command line, take appropriate processing action.
processing
- based on the file(s) specified, read the contents of each file and use appropriate objects to store it
- based on the command line arguments/options, process the data accordingly, which includes
- data preprocessing (split a multi-day record into single day record)
- record processing (preform required computation)
output
- output the required report based on the processed data
identify and select appropriate python objects and functions
The following python functions (to be created, you may have more) are useful in handling the following sub-tasks:
- reads login records from files and filters out unwanted records
- convert login records into proper python object type so that it can be processed using as much built-in functions as possible
- create function which generates daily usage reports by user and/or by remote host
- create function which generates weekly usage reports by user and/or by remote host
To help you with this assignment, you can use the ur_template.py in the sample ops435-a2 repository as a starting point in designing your own Python Usage Report script. If you don't have enough time to create all the functions for the data processing steps, you should study the functions in the ur_funcs.py (provided by your teacher), pick and use the one that may help.
Python script coding and debugging
For each function, identify what type of objects should be passed to the function, and what type of objects should be returned to the caller. Once you have finished coding a function, you should start a Python3 interactive shell, import your functions and manually test each function and verify its correctness.
Final Test
Once you have all the individual function tested and that each is working properly, perform the final test with test data provided by your professor and verify that your script produces the correct results before submitting your python program on Blackboard. Upload all the files for this assignment 2 to your vm in myvmlab and perform the final test.
Sample login/logout records file and sample test run results
- can be found from the sample repository github.com/rayfreeping/ops435-a2
Rubric
| Task | Maximum mark | Actual mark |
|---|---|---|
| User Requirement Document | 20 | |
| Program usage and Options | 20 | |
| Generate user name list | 10 | |
| Generate remote host IP list | 10 | |
| Daily Usage Report by User | 10 | |
| Daily Usage Report by Remote Host | 10 | |
| Weekly Usage Report by User | 10 | |
| Weekly Usage Report by Remote Host | 10 | |
| Total | 100 |
Submission
- Stage 1: upload your algorithm document file to your ops435-a2r repository in github.com by November 25, 2020
- Stage 2: upload your python script for this assignment to your ops435-a2r repository in github.com and to your vm in myvmlab by Dec 2, 2020
- Stage 3: After fully tested and debugged your python script for this assignment, update your algorithm, your python script, and your est results to your ops435-a2r repository in github.com. Also submit the algorithm document, the python script and final test result to blackboard by Dec 4, 2020
