Feature/task12 azure function usersId #49

theKunte · 2021-01-19T03:45:44Z

Task: #12

EXPECTED RESULTS FOR API ENDPOINT USERS/{userId}

HTTP request for endpoint users/userid:
Note when changing the id in the URL you will retrieve a different user.
This will show the users that are added to the DB and it is deployed to Azure Functions.

Test Function in Azure

Sign in to Azure.
Find nsc-function-team1 resource group
Select nsc-functionapp-team1
In the Navbar on th left select functions and click on HttpTriggerAPIUserId
Click on Code + Test on left nav bar
Click on function URL and test the function in the URL
It will return json {}
If it is not working on the first try wait for 30 seconds and try again
Test: users/1

Create and deploy Azure Functions from Visual Studio Code:

Create a serverless app in vscode with extensions and python:

Prerequisites:
- Create or use existing Azure Subscription
- Install software to local workstation:
  - Install the Azure Functions Core Tools in Visual Studio Code
  - Install Python and Visual Studio Code with the Azure Function extension.
  - Sign in to Azure.
  - Verify your environment:
  NOTE: Azure function only work with Python version 3.6, 3.7 and 3.8.
  Reference: https://docs.microsoft.com/en-us/azure/developer/python/tutorial-vs-code-serverless-python-01
```
 Verify your environment:
 `npm install -g azure-functions-core-tools` 
```
1. Create a Python function for Azure functions:
  Reference: https://docs.microsoft.com/en-us/azure/developer/python/tutorial-vs-code-serverless-python-02
  Note: When creating a HttpTriger in Visual Studio Code open the function folder in a separate window in Visual Studio Code and create your function in there. This will help to structure your Triggers and keep files in the same folder instead of in the root folder

3. Examine the Python code files in vscode:
Reference:

https://docs.microsoft.com/en-us/azure/developer/python/tutorial-vs-code-serverless-python-03

4. Debug the Azure Functions Python Code locally:

Reference:

https://docs.microsoft.com/en-us/azure/developer/python/tutorial-vs-code-serverless-python-04?tabs=powershell

5. Deploy Azure Function in Python

Reference: https://docs.microsoft.com/en-us/azure/developer/python/tutorial-vs-code-serverless-python-05

Purpose: This feature implemented the API endpoint for getting a specific user by userId.

TEST PULL REQUEST:

Requirements to set up Azure Function and Deploy them to Azure:

Clone repository:
- Install Azure Functions extension in vscode.
- Open the functions folder separately in vscode.
  Note: if you have the root repository folder open the azure.function extension will not work.
- Install Python version 3.8 if you haven't yet
- Note: Azure function does not work with Python 3.9 See documentation: https://docs.microsoft.com/en-us/azure/azure-functions/functions-reference-python
- Set up environment in vscode/ .venv
- Sign in to Azure
- Deploy your functions once you completed all functionality and tested it locally.
  To test it locally and Debug Functions:

Azure Function Setup:

  -  Create a resource group for Azure Function
  -  Deploy your function to Azure from vscode
  -  Note: select correct Subscription

local packages to install:**

 - pip install pypyodbc
 - NOTE: you can also use pyodbc ( This example uses pypyodbc)
 - More Documentation found here: https://medium.com/globant/serverless-applications-with-azure-functions-python-and-docker-b594fb90fd4f
 - https://pypi.org/project/pypyodbc/
 -  pip install azure.function
 - Add these to the required file if they haven't been added automatically 
 - Check for ODBC Driver: 
 This PR is using ODBC Driver 17
 https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver15

Setup local.settings.json

-Access to Azure resources needed to access passwords
resource group: nsc-functions-team1

Verify that your local.settings.json file contains the following:

"FUNCTIONS_WORKER_RUNTIME": "addPasswordHere"
"ENV_DATABASE_USERNAME": "addPasswordHere"
"ENV_DATABASE_PASSWORD": "addPasswordHere"
"ENV_DATABASE_NAME": "addPasswordHere"
"ENV_DATABASE_SERVER": "addPasswordHere"

Troubleshoot ODBC Driver

Reference:

DATE	ACTIVITY	TIME
1/9	Research Azure Function examples	60 minutes
1/10	More Research about Azure Function setup and deployment	60 minutes
1/11	Started reading about Azure Functions + Deployment	30 minutes
1/15	Testing Azure Function locally and applied new material from lecture	120 minutes
1/16	Create a resource group in azure and host all functions on one host troubleshoot a bunch!	60 minutes
1/17	connect resource group with DB and connected it correctly luckily!	60 minutes
1/17	Research Azure function implementation and troubleshoot	360 minutes
1/17	More research and troubleshooting	120 minutes
1/18	Additional coding and test function for userId	90 minutes
1/18	Add additional HTTP responses	60 minutes
1/18	Testing	30 minutes
1/18	Deploy functions locally to azure successfull	30 minutes
1/18	Small changes	30 minutes
1/18	Wrote this PR and probably have to update it again :D	45 min
1/19	Reviewed Comments and added changes	120 min
1/19	Met with some of my team to review issues with ODBC	240 min
1/20	Changed API endpoint for users/userId	220 min
1/20	Updated this Documentation	60 min

file is not needed

can be deleted

remove functions that are not associated with HttpTriggerAPIUsersId

removed .vscode files

remove files that should not be included

…12-azure-function-usersId

lbrown51 · 2021-01-19T21:13:02Z

functions/HttpTriggerAPIUsersId/__init__.py

+import azure.functions as func
+import json
+
+


Would love to see some comments in this file. I think it would definitely be helpful in identifying what's going on at the different stages.

Will add comments!

functions/HttpTriggerAPIUsersId/__init__.py

lbrown51 · 2021-01-19T21:14:29Z

functions/HttpTriggerAPIUsersId/__init__.py

+    connectionString = "Driver={};Server={};Database={};Uid={};Pwd={};Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;".format(
+        driver, db_server, db_name, db_username, db_password)
+
+    id = req.params.get('id')


What is this id for? Whose id is it?

@lbrown51 this id is the id that gets passed as a parameter when this function gets called.

this is the userId.
Natalia suggested renaming this "id" to "userId" for clarification. The way I have it right now makes it confusing. Will update it

Awesome! I think that makes a lot of sense. Currently, it could be misinterpreted as a separate id of some kind.

Yes! good practice to keep names for the parameters same across the board. I used userId and taskId in my code

lbrown51 · 2021-01-19T21:16:01Z

functions/HttpTriggerAPIUsersId/__init__.py

+    else:
+        try:
+            with pypyodbc.connect(connectionString) as conn:
+                return execute_query(conn, id)


Do you think it would make sense, instead of having "execute_query" to name the function something like "get_user_by_id"?

For naming conventions, I would change it to your suggestion. Will update it!

I used a generic name here, so that it could be repurposed for different methods (get, update, post, delete)

functions/HttpTriggerAPIUsersId/__init__.py

farhadbahrehmandhenry · 2021-01-19T22:22:32Z

functions/HttpTriggerAPIUsersId/__init__.py

+    connectionString = "Driver={};Server={};Database={};Uid={};Pwd={};Encrypt=yes;TrustServerCertificate=no;Connection Timeout=30;".format(
+        driver, db_server, db_name, db_username, db_password)
+
+    id = req.params.get('id')


@lbrown51 this id is the id that gets passed as a parameter when this function gets called.

functions/HttpTriggerAPIUsersId/__init__.py

…ure/task12-azure-function-usersId" This reverts commit 0bc49cb, reversing changes made to 2d470d5.

nataliagourova · 2021-01-20T07:36:43Z

I tested the functionality via the test tool on Azure, works as expected. Overall, it'd be great to see more comments to help those who continue to develop the API down the road.

nataliagourova · 2021-01-20T07:38:56Z

functions/HttpTriggerAPIUsersId/__init__.py

+            # https://stackoverflow.com/questions/16519385/output-pyodbc-cursor-results-as-python-dictionary/16523148#16523148
+            columns = [column[0] for column in cursor.description]
+            data = dict(zip(columns, row))
+


Some of the sources I looked into mention closing the connection after you open, such as cursor.close() and conn.close()

the comment did not get attached to the correct line. connection needs to be closed after the query executes

nataliagourova

see inline comments

lbrown51

Everything looks great. All my comments were addressed :)

theKunte added 6 commits January 17, 2021 13:34

added files to .gitignore

b86acca

added parameters for functions

cbcde06

fixed connectionString and retrieved data

1573224

retrieve correct data from database for usersId

6c4ce9b

added additional http responses

fdb1840

added additional http requests

d62cab8

theKunte added the Work-in-Progress Pull Request not ready for review label Jan 19, 2021

theKunte added this to the Sprint 01 milestone Jan 19, 2021

theKunte requested review from lbrown51, jak-ashuraliev, farhadbahrehmandhenry, nataliagourova and David-Prism January 19, 2021 03:45

theKunte self-assigned this Jan 19, 2021

theKunte added 3 commits January 18, 2021 19:46

Delete test.txt

ab69497

file is not needed

Delete test.txt

86cbd17

can be deleted

Delete test.txt

f00874e

can be deleted

theKunte requested a review from toddysm January 19, 2021 03:53

theKunte added the team1 Issues for Practicum Team 1 label Jan 19, 2021

theKunte linked an issue Jan 19, 2021 that may be closed by this pull request

[TASK] Implement Azure Function for users/{user_id} API #12

Closed

theKunte changed the title ~~Feature/task12 azure function users~~ Feature/task12 azure function usersId Jan 19, 2021

theKunte added 9 commits January 19, 2021 11:06

Delete __init__.py

c91445e

remove functions that are not associated with HttpTriggerAPIUsersId

Delete function.json

40261e7

remove functions that are not associated with HttpTriggerAPIUsersId

Delete sample.dat

47c7856

remove functions that are not associated with HttpTriggerAPIUsersId

Delete extensions.json

df4083c

removed .vscode files

Delete launch.json

db07867

removed .vscode files

Delete settings.json

2b64470

removed .vscode files

Delete tasks.json

6bfa205

removed .vscode files

Delete __init__.py

53a5d19

remove files that should not be included

Delete function.json

c16320a

remove files that should not be included

theKunte added 4 commits January 19, 2021 11:31

Delete sample.dat

1017518

remove files that should not be included

Delete __init__.py

1a27229

remove files that should not be included

Delete function.json

697e3fd

remove files that should not be included

Delete sample.dat

2d470d5

remove files that should not be included

theKunte removed the Work-in-Progress Pull Request not ready for review label Jan 19, 2021

Merge remote-tracking branch 'upstream/development' into feature/task…

0bc49cb

…12-azure-function-usersId

lbrown51 reviewed Jan 19, 2021

View reviewed changes

farhadbahrehmandhenry reviewed Jan 19, 2021

View reviewed changes

Lenny Brown and others added 3 commits January 19, 2021 17:48

Revert "Merge remote-tracking branch 'upstream/development' into feat…

afb9200

…ure/task12-azure-function-usersId" This reverts commit 0bc49cb, reversing changes made to 2d470d5.

added comments and changed naming conventions as suggested

d6a0000

added comments and name convention

fd8b3c3

nataliagourova reviewed Jan 20, 2021

View reviewed changes

theKunte and others added 3 commits January 20, 2021 12:20

ignore .vscode

9a7b878

additional comments

8fb2d88

Merge branch 'development' into feature/task12-azure-function-usersId

945e4dd

lbrown51 approved these changes Jan 21, 2021

View reviewed changes

nataliagourova self-requested a review January 21, 2021 02:50

nataliagourova approved these changes Jan 21, 2021

View reviewed changes

nataliagourova mentioned this pull request Jan 21, 2021

[Task] 4 Implement Azure Function for users/{user_id}/tasks/{task_id} API #6 by Natalia #58

Closed

theKunte merged commit 457dcb1 into North-Seattle-College:development Jan 21, 2021

nataliagourova mentioned this pull request Jan 21, 2021

Natalia issue6 temp #61

Merged

theKunte mentioned this pull request Jan 29, 2021

Feature/team1/Issue71/completeAzureUsersUserIdFunction #89

Merged

Kemet2016 mentioned this pull request Feb 1, 2021

Feature/task03/completeUserId/tasks_function #107

Merged

theKunte mentioned this pull request Feb 1, 2021

[BUG] Complete the rest of CRUD functionality of API Users/{userId} #71

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/task12 azure function usersId #49

Feature/task12 azure function usersId #49

theKunte commented Jan 19, 2021 •

edited

Loading

lbrown51 Jan 19, 2021

theKunte Jan 19, 2021

lbrown51 Jan 19, 2021

farhadbahrehmandhenry Jan 19, 2021 •

edited

Loading

theKunte Jan 19, 2021

lbrown51 Jan 19, 2021

nataliagourova Jan 20, 2021

lbrown51 Jan 19, 2021

theKunte Jan 20, 2021

nataliagourova Jan 20, 2021

farhadbahrehmandhenry Jan 19, 2021 •

edited

Loading

nataliagourova commented Jan 20, 2021

nataliagourova Jan 20, 2021

nataliagourova Jan 20, 2021

nataliagourova left a comment

lbrown51 left a comment

Feature/task12 azure function usersId #49

Feature/task12 azure function usersId #49

Conversation

theKunte commented Jan 19, 2021 • edited Loading

EXPECTED RESULTS FOR API ENDPOINT USERS/{userId}

Create and deploy Azure Functions from Visual Studio Code:

4. Debug the Azure Functions Python Code locally:

5. Deploy Azure Function in Python

Requirements to set up Azure Function and Deploy them to Azure:

Azure Function Setup:

local packages to install:**

Setup local.settings.json

Troubleshoot ODBC Driver

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farhadbahrehmandhenry Jan 19, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

farhadbahrehmandhenry Jan 19, 2021 • edited Loading

Choose a reason for hiding this comment

nataliagourova commented Jan 20, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nataliagourova left a comment

Choose a reason for hiding this comment

lbrown51 left a comment

Choose a reason for hiding this comment

theKunte commented Jan 19, 2021 •

edited

Loading

farhadbahrehmandhenry Jan 19, 2021 •

edited

Loading

farhadbahrehmandhenry Jan 19, 2021 •

edited

Loading