Difference between revisions of "SPO600 Framework Project"
(→API Specifications) |
(→API Specifications) |
||
Line 17: | Line 17: | ||
== API Specifications == | == API Specifications == | ||
− | config -> name of package write to file (analys.txt) for benchmark | + | ''' config file''' -> name of package write to file (analys.txt) for benchmark <br> |
− | + | ''' parse config ''' -> one group per line, options delimited by "|" (STDOUT) <br> | |
− | permute options -> one permutation per line (STDOUT) + ID of groups and group itself to analys.txt | + | ''' permute options ''' -> one permutation per line (STDOUT) + ID of groups and group itself to analys.txt <br> |
− | build -> status code and location of start up script + build time, memory used, load of CPU (or it can be called in main) and status code to analys.txt | + | ''' build ''' -> status code and location of start up script + build time, memory used, load of CPU (or it can be called in main) and status code to analys.txt <br> |
− | test -> status code + status code to analys.txt | + | ''' test ''' -> status code + status code to analys.txt |
− | + | analys.txt -> ''' benchmark ''' -> SQL Database | |
− | Basically, analys.txt would look like this: | + | Basically, ''' analys.txt ''' would look like this: |
<pck name> | <pck name> |
Revision as of 22:37, 22 October 2015
Contents
Who's Doing What
The driver for each piece is in bold. Please don't be confined by this list -- contribute to any section as you see fit.
- Config file format - Miguel, Andy, Shirwa
- Initial option lists for config file - James, Andy
- Config file parser - Gaurav, Miguel, Shirwa
- Permute test cases - Ramanan, Donald, Han
- Build - Yehoshua, Jayme, Nitish, Joel
- Test (Sanity Check/Successful Build Test) - Nitish, Dmytro, Ramanan
- Benchmark - Jayme, Yehoshua, Nitish
- Analysis tools/reporting - Kirill, Gaurav
- Code wrangler/git repo maintainer/QA - Joel, Jayme, James
- Inter-module API Coordination - Donald, Kirill, Dmytro
- Top-level bash script - Chris Tyler
API Specifications
config file -> name of package write to file (analys.txt) for benchmark
parse config -> one group per line, options delimited by "|" (STDOUT)
permute options -> one permutation per line (STDOUT) + ID of groups and group itself to analys.txt
build -> status code and location of start up script + build time, memory used, load of CPU (or it can be called in main) and status code to analys.txt
test -> status code + status code to analys.txt
analys.txt -> benchmark -> SQL Database
Basically, analys.txt would look like this:
<pck name>
ID1 of group of options + options ID1 + build time, memory, CPU load, status code of build ID1 + status code of test ID2 +options ID2 + build time, memory, CPU, status code of build etc
<pck name 2>
ID1 etc
ID can be used just once - in this case it can be like a delimiter tat separates groups of options.
This is just a draft.
GitHub Repository
Here's the link to the Github repo: SPO600-Build-Framework
Config file name: ./monkeys10k.config
Instructions for Submitting a Pull Request
- Create a Github account.
- Navigate to the project repo by the link above.
- In the top right of the page make sure that you are "Watching" the repo: https://i.gyazo.com/f887e6199af0f73453556ca0e96dc2bb.png
- Click the Fork button.
- This should create a your own version of the repo.
- Clone the newly forked repo and begin adding your additions/changes.
- Once you have committed and pushed your changes to your own repo, submit a Pull Request, by clicking on the link on the right side of the repo page.
- Click New Pull Request.
- Click Create Pull Request, and add any comments about the pull request that you would like the Code Wranglers to know about (be descriptive about what is going on in your submission).
- The Code Wranglers will manage all pull requests and comment on any that might conflict with the main repo.
If you are still having trouble, GitHub's Using pull requests article might be helpful also.