Add put endpoint for editing site #88

ericcccsliu · 2023-04-22T18:06:10Z

Pull Request

Adds PUT endpoint for editing site details!

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce.
Please also list any relevant details for your test configuration

wrote tests!

Checklist:

My code follows OCF's coding style guidelines
I have performed a self-review of my own code
I have made corresponding changes to the documentation
I have added tests that prove my fix is effective or that my feature works
I have checked my code and corrected any misspellings

Create clearsky forecast endpoint

Issue/future forecasts

This doesn't change the result but speeds up the query in general.

Add WHERE statement on query for past forecasts

Make site_uuid field on PVSiteMetadata model optional

…d-logging

Issue/add logging

Create multiple clearsky endpoint

codecov · 2023-04-23T17:25:05Z

Codecov Report

Merging #88 (9ed54b5) into h4i/enode (a4fb461) will increase coverage by 2.24%.
The diff coverage is 95.09%.

@@              Coverage Diff              @@
##           h4i/enode      #88      +/-   ##
=============================================
+ Coverage      87.31%   89.56%   +2.24%     
=============================================
  Files              9       11       +2     
  Lines            410      527     +117     
=============================================
+ Hits             358      472     +114     
- Misses            52       55       +3

Impacted Files	Coverage Δ
pv_site_api/session.py	`37.50% <0.00%> (ø)`
pv_site_api/auth.py	`90.47% <90.47%> (ø)`
pv_site_api/main.py	`92.23% <94.80%> (+1.68%)`	⬆️
pv_site_api/cache.py	`97.14% <97.14%> (ø)`
pv_site_api/__init__.py	`100.00% <100.00%> (ø)`
pv_site_api/_db_helpers.py	`100.00% <100.00%> (ø)`
pv_site_api/pydantic_models.py	`100.00% <100.00%> (ø)`

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

AndrewLester · 2023-04-23T19:59:58Z

tests/test_sites.py

@@ -26,7 +25,6 @@ def test_get_site_list(client, sites):

 def test_put_site_fake(client, fake):


This isn't part of your stuff, but for consistency, rename to test_post_site_fake?

AndrewLester · 2023-04-23T20:01:15Z

pv_site_api/main.py

+    if site is None:
+        raise HTTPException(status_code=404, detail="Site not found")
+
+    # update site information


Suggested change

# update site information

AndrewLester · 2023-04-23T20:01:20Z

pv_site_api/main.py

+    site.longitude = site_info.longitude
+    site.capacity_kw = site_info.installed_capacity_kw
+
+    # commit changes to database


Suggested change

# commit changes to database

AndrewLester · 2023-04-23T20:01:31Z

pv_site_api/main.py

+    client = session.query(ClientSQL).first()
+    assert client is not None
+
+    # get the site to update


Suggested change

# get the site to update

* Bump version: 0.0.36 → 0.0.37 * TDD: add failing test, looking at forecasts in the future * add start utc filter on forecast future qery * lint * lint * isort * add freeze gun to dev dependencies * self PR comments * Bump version: 0.0.37 → 0.0.38 * Make site_uuid field on PVSiteMetadata model optional * Make pydantic field optional * Move test site with real UUID to real db test * Don't use uuid in tests * Add part of check back * Ensure autogenerated site uuid is not null in database * Add WHERE statement on query for past forecasts This doesn't change the result but speeds up the query in general. * Bump version: 0.0.38 → 0.0.39 * Bump version: 0.0.39 → 0.0.40 * add logging * lint * run blacks * add extra logs * Bump version: 0.0.40 → 0.0.41 * add structlogging * add structlog to requiremwnts * add logging * Bump version: 0.0.41 → 0.0.42 * Add structlog initialisation * blacks * isort * Bump version: 0.0.42 → 0.0.43 * Uniformize check to FAKE and fix related test * Set codecov targets * Hard-code the "now" time for all tests This means that the same tests are run now matter the time at which we run them. * add caching * fix * lint * isort * fix for routes calling routes * lint * Bump version: 0.0.43 → 0.0.44 * PR comment * add args to cache * lint * Update pv_site_api/cache.py Co-authored-by: Simon Lemieux <1105380+simlmx@users.noreply.github.com> * tidy * Bump version: 0.0.44 → 0.0.45 * What I've got * Add basic authorization to the /sites* routes The caller of the routes must have a proper Bearer authorization header set. * refactor * add tests * fix error in import * update pvsite-datamodel (in line with main) * fix bug * fix incompatible types * lint and format * add site existence check * add back correct datamodel dependency * fix test name * allow tests to pass by adding fake condition * remove 404 check * use or instead of is not none * Bump version: 0.0.45 → 0.0.46 * add site existence check * format and lint * Bump version: 0.0.46 → 0.0.47 * add post endpoint * add test back in * fix errors and format * add site name to test * fix tiny error * fix another small error * run tests * fix bugs * lint and format * fix fake * :pleading-face: * yet another is_fake() addition * address comments --------- Co-authored-by: Peter Dudfield <34686298+peterdudfield@users.noreply.github.com> Co-authored-by: BumpVersion Action <bumpversion@github-actions> Co-authored-by: peterdudfield <peter.dudfield@hotmail.com> Co-authored-by: AndrewLester <alester220@gmail.com> Co-authored-by: Simon Lemieux <1105380+simlmx@users.noreply.github.com> Co-authored-by: devsjc <sol@openclimatefix.org>

* Bump version: 0.0.36 → 0.0.37 * TDD: add failing test, looking at forecasts in the future * add start utc filter on forecast future qery * lint * lint * isort * add freeze gun to dev dependencies * self PR comments * Bump version: 0.0.37 → 0.0.38 * Make site_uuid field on PVSiteMetadata model optional * Make pydantic field optional * Move test site with real UUID to real db test * Don't use uuid in tests * Add part of check back * Ensure autogenerated site uuid is not null in database * Add WHERE statement on query for past forecasts This doesn't change the result but speeds up the query in general. * Bump version: 0.0.38 → 0.0.39 * Bump version: 0.0.39 → 0.0.40 * add logging * lint * run blacks * add extra logs * Bump version: 0.0.40 → 0.0.41 * add structlogging * add structlog to requiremwnts * add logging * Bump version: 0.0.41 → 0.0.42 * Add structlog initialisation * blacks * isort * Bump version: 0.0.42 → 0.0.43 * Uniformize check to FAKE and fix related test * Set codecov targets * Hard-code the "now" time for all tests This means that the same tests are run now matter the time at which we run them. * add caching * fix * lint * isort * fix for routes calling routes * lint * Bump version: 0.0.43 → 0.0.44 * PR comment * add args to cache * lint * Update pv_site_api/cache.py Co-authored-by: Simon Lemieux <1105380+simlmx@users.noreply.github.com> * tidy * Bump version: 0.0.44 → 0.0.45 * What I've got * Add basic authorization to the /sites* routes The caller of the routes must have a proper Bearer authorization header set. * refactor * add tests * fix error in import * update pvsite-datamodel (in line with main) * fix bug * fix incompatible types * lint and format * add site existence check * add back correct datamodel dependency * fix test name * allow tests to pass by adding fake condition * remove 404 check * use or instead of is not none * Bump version: 0.0.45 → 0.0.46 * add site existence check * format and lint * Bump version: 0.0.46 → 0.0.47 * add post endpoint * add test back in * fix errors and format * add site name to test * fix tiny error * fix another small error * run tests * fix bugs * lint and format * fix fake * :pleading-face: * yet another is_fake() addition * address comments --------- Co-authored-by: Peter Dudfield <34686298+peterdudfield@users.noreply.github.com> Co-authored-by: BumpVersion Action <bumpversion@github-actions> Co-authored-by: peterdudfield <peter.dudfield@hotmail.com> Co-authored-by: AndrewLester <alester220@gmail.com> Co-authored-by: Simon Lemieux <1105380+simlmx@users.noreply.github.com> Co-authored-by: devsjc <sol@openclimatefix.org> Fix some functions Fix Enode link endpoint Remove duplicate fixture Rename /inverters to /enode/inverters

peterdudfield and others added 30 commits March 24, 2023 21:04

Merge pull request #55 from openclimatefix/clearsky-forecast-endpoint

a9fb439

Create clearsky forecast endpoint

Bump version: 0.0.36 → 0.0.37

01a5e21

TDD: add failing test, looking at forecasts in the future

17341a8

add start utc filter on forecast future qery

8495325

lint

50d8f67

lint

b4c83ac

isort

b806ea9

add freeze gun to dev dependencies

de2de3e

self PR comments

f0e1800

Merge pull request #64 from openclimatefix/issue/future-forecasts

d4e397d

Issue/future forecasts

Bump version: 0.0.37 → 0.0.38

25904bb

Make site_uuid field on PVSiteMetadata model optional

3157e67

Make pydantic field optional

585bb2d

Move test site with real UUID to real db test

48e08ff

Don't use uuid in tests

8520566

Add part of check back

d6f59e5

Ensure autogenerated site uuid is not null in database

89910a0

Add WHERE statement on query for past forecasts

c93f46f

This doesn't change the result but speeds up the query in general.

Merge pull request #66 from openclimatefix/optimize-forecast-query

f5bb648

Add WHERE statement on query for past forecasts

Bump version: 0.0.38 → 0.0.39

ceeecd0

Merge pull request #65 from openclimatefix/db-id-generation

dacdf29

Make site_uuid field on PVSiteMetadata model optional

Bump version: 0.0.39 → 0.0.40

db98579

add logging

15afb03

Merge commit 'db98579aa877a5b8fd906477921a627f28b76569' into issue/ad…

47f8fa3

…d-logging

lint

f1b4d71

run blacks

920e5c9

add extra logs

d357c2c

Merge pull request #67 from openclimatefix/issue/add-logging

2761085

Issue/add logging

Bump version: 0.0.40 → 0.0.41

7a4586a

add structlogging

b0c61f4

ericcccsliu and others added 6 commits April 19, 2023 12:34

add site existence check

fc0f3a3

format and lint

5eecace

Merge pull request #84 from openclimatefix/al/multiple-clearsky

3e63ffe

Create multiple clearsky endpoint

Bump version: 0.0.46 → 0.0.47

e8fae44

merge in main

7b67556

add post endpoint

3c7c3ba

ericcccsliu marked this pull request as draft April 22, 2023 18:06

ericcccsliu added 5 commits April 22, 2023 13:15

add test back in

cfe6aa6

fix errors and format

1600aac

add site name to test

74d59dd

fix tiny error

8a7b6c4

fix another small error

0cc2a45

AndrewLester changed the base branch from main to h4i/enode April 23, 2023 17:32

ericcccsliu added 5 commits April 23, 2023 13:01

run tests

fccdeb1

fix bugs

5da0e67

lint and format

2afc24e

fix fake

300f468

:pleading-face:

de944b7

ericcccsliu marked this pull request as ready for review April 23, 2023 19:46

ericcccsliu added 2 commits April 23, 2023 14:48

merge in h4i/enode

24ac3fe

yet another is_fake() addition

32478d2

ericcccsliu requested a review from AndrewLester April 23, 2023 19:54

AndrewLester approved these changes Apr 23, 2023

View reviewed changes

address comments

9ed54b5

ericcccsliu merged commit a058e32 into h4i/enode Apr 23, 2023

ericcccsliu deleted the el/add-post-endpoint branch April 23, 2023 20:10

ericcccsliu changed the title ~~[WIP] Add put endpoint for editing site~~ Add put endpoint for editing site Apr 23, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add put endpoint for editing site #88

Add put endpoint for editing site #88

Uh oh!

ericcccsliu commented Apr 22, 2023 •

edited

Loading

Uh oh!

codecov bot commented Apr 23, 2023 •

edited

Loading

Uh oh!

AndrewLester Apr 23, 2023

Uh oh!

AndrewLester Apr 23, 2023

Uh oh!

AndrewLester Apr 23, 2023

Uh oh!

AndrewLester Apr 23, 2023

Uh oh!

Uh oh!

		@@ -26,7 +25,6 @@ def test_get_site_list(client, sites):

		def test_put_site_fake(client, fake):

Uh oh!

Add put endpoint for editing site #88

Add put endpoint for editing site #88

Uh oh!

Conversation

ericcccsliu commented Apr 22, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

How Has This Been Tested?

Checklist:

Uh oh!

codecov bot commented Apr 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

AndrewLester Apr 23, 2023

Choose a reason for hiding this comment

Uh oh!

AndrewLester Apr 23, 2023

Choose a reason for hiding this comment

Uh oh!

AndrewLester Apr 23, 2023

Choose a reason for hiding this comment

Uh oh!

AndrewLester Apr 23, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ericcccsliu commented Apr 22, 2023 •

edited

Loading

codecov bot commented Apr 23, 2023 •

edited

Loading