Difference between revisions of "SPO600 Framework Project"

From CDOT Wiki
Jump to: navigation, search
(Instructions for Submitting a Pull Request)
(API Specifications)
Line 17: Line 17:
 
== API Specifications ==
 
== API Specifications ==
  
(Please add!)
+
config -> name of package write to file (analys.txt) for benchmark
 +
config file->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 ==
 
== GitHub Repository ==

Revision as of 22:30, 22 October 2015

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.

  1. Config file format - Miguel, Andy, Shirwa
  2. Initial option lists for config file - James, Andy
  3. Config file parser - Gaurav, Miguel, Shirwa
  4. Permute test cases - Ramanan, Donald, Han
  5. Build - Yehoshua, Jayme, Nitish, Joel
  6. Test (Sanity Check/Successful Build Test) - Nitish, Dmytro, Ramanan
  7. Benchmark - Jayme, Yehoshua, Nitish
  8. Analysis tools/reporting - Kirill, Gaurav
  9. Code wrangler/git repo maintainer/QA - Joel, Jayme, James
  10. Inter-module API Coordination - Donald, Kirill, Dmytro
  11. Top-level bash script - Chris Tyler

API Specifications

config -> name of package write to file (analys.txt) for benchmark config file->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

  1. Create a Github account.
  2. Navigate to the project repo by the link above.
  3. In the top right of the page make sure that you are "Watching" the repo: https://i.gyazo.com/f887e6199af0f73453556ca0e96dc2bb.png
  4. Click the Fork button.
  5. This should create a your own version of the repo.
  6. Clone the newly forked repo and begin adding your additions/changes.
  7. 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.
  8. Click New Pull Request.
  9. 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).
  10. 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.