Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add ability to upload and retrieve simulation reports #297

Merged
merged 3 commits into from
Nov 12, 2018

Conversation

CampGareth
Copy link
Contributor

@CampGareth CampGareth commented Nov 5, 2018

Currently we generate area utilisation stats for Builds and store them as reports. These stats give users an idea of how optimised their design is compared to previous versions. You don't have to do a full build to generate these stats however, you can get them from a Simulation. We've added the generation of these reports to reco-sdaccel so now we need platform to offer API endpoints for storing reports.

New API features:

  • GET /simulations/<id>/reports
  • POST /simulations/<id>/reports

The POST will be used by workers running Simulations. The GET will be used by reco to view stored reports.

Checklist

  • Thought about testing?
  • Is the intent of the code clear? (use comments judiciously!)
  • Added to RELEASE.md?

@CampGareth CampGareth force-pushed the feature/simulation-reports-fixed branch from cde744d to 86e60b0 Compare November 6, 2018 11:15
models/simulation.go Outdated Show resolved Hide resolved
models/simulation.go Outdated Show resolved Hide resolved
models/simulation.go Outdated Show resolved Hide resolved
@CampGareth CampGareth changed the title [WIP] add ability to upload and retrieve simulation reports add ability to upload and retrieve simulation reports Nov 6, 2018
handlers/api/simulation.go Outdated Show resolved Hide resolved
@CampGareth CampGareth force-pushed the feature/simulation-reports-fixed branch from 8f851db to 22429ca Compare November 12, 2018 11:59
@CampGareth
Copy link
Contributor Author

"added to release.md" no but this is the sort of thing that should be since it's user-facing. I mean assuming we had a release.md in this repo. Time to investigate setting one up

Copy link
Contributor

@pwaller pwaller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, nice that the scope is not too large! 💯

A few important suggestions in here though. 📝

handlers/api/simulation.go Outdated Show resolved Hide resolved
handlers/api/simulation.go Outdated Show resolved Hide resolved
handlers/api/simulation.go Show resolved Hide resolved
handlers/api/simulation.go Show resolved Hide resolved
handlers/api/simulation_test.go Outdated Show resolved Hide resolved
handlers/api/simulation_test.go Outdated Show resolved Hide resolved
handlers/api/simulation_test.go Outdated Show resolved Hide resolved
handlers/api/simulation_test.go Outdated Show resolved Hide resolved
handlers/api/simulation.go Show resolved Hide resolved
@CampGareth CampGareth force-pushed the feature/simulation-reports-fixed branch 3 times, most recently from 831ade1 to 567a053 Compare November 12, 2018 16:58
models/simulation.go Outdated Show resolved Hide resolved
handlers/api/simulation.go Show resolved Hide resolved
@CampGareth CampGareth force-pushed the feature/simulation-reports-fixed branch from 65656e7 to e342d74 Compare November 12, 2018 17:50
@pwaller pwaller merged commit 35ffe7f into master Nov 12, 2018
@pwaller
Copy link
Contributor

pwaller commented Nov 12, 2018

🎯

@pwaller pwaller deleted the feature/simulation-reports-fixed branch November 12, 2018 21:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants