microsoft / todo-app-java-on-azure Goto Github PK

Sample TODO app using Java on Azure

License: MIT License

Shell 6.78% Java 45.23% JavaScript 15.92% HTML 14.04% Groovy 17.41% Dockerfile 0.61%

todo-app-java-on-azure's Introduction

Todo App Java On Azure

This TodoList app is an Azure Java application. It provides end-to-end CRUD operation to todo list item from front-end AngularJS code. Behind the scene, todo list item data store is Azure CosmosDB DocumentDB. This application uses [Azure CosmosDB] (https://github.com/Azure/azure-cosmosdb-java), [Azure DocumentDB] (https://docs.microsoft.com/en-us/azure/cosmos-db/sql-api-introduction) Spring Boot Starter, and AngularJS to interact with Azure. This sample application provides several deployment options to deploy to Azure, pls see deployment section below. With Azure support in Spring Starters, maven plugins and Eclipse/IntelliJ plugins, Azure Java application development and deployment is effortless now.

Requirements

JDK 1.8 and above
Maven 3.0 and above

Create Azure Cosmos DB documentDB

You can follow our steps using Azure CLI 2.0 to deploy an Azure Cosmos DB documentDB, or follow this article to create it from Azure portal.

az login
az account set -s <your-subscription-id>

create an Azure Resource Group, and note your group name

az group create -n <your-azure-group-name> -l <your-resource-group-region>

create Azure Cosmos DB with DocumentDB kind. Note the documentEndpoint field in the response.
```
az cosmosdb create --kind GlobalDocumentDB -g <your-azure-group-name> -n <your-azure-documentDB-name>
```
Note name of cosmos db must be in lowercase.
get your Azure Cosmos DB key, get the primaryMasterKey of the DocumentDB you just created.
```
az cosmosdb list-keys -g <your-azure-group-name> -n <your-azure-documentDB-name>
```

Configuration

Note your DocumentDB uri and key from last step, specify a database name but no need to create it. Then modify src/main/resources/application.properties file and save it.
```
azure.documentdb.uri=put-your-documentdb-uri-here
azure.documentdb.key=put-your-documentdb-key-here
azure.documentdb.database=put-your-documentdb-databasename-here
```
If you don't want to modify configuration in the source code manually, you can put variables in this file and set their values in system environment variables: DOCUMENTDB_URI, DOCUMENTDB_KEY and DOCUMENTDB_DBNAME. Then maven will substitute them during the build phase.
```
[email protected]_URI@
[email protected]_KEY@
[email protected]_DBNAME@
```

Run it

package the project using mvn package
Run the project using java -jar target/todo-app-java-on-azure-1.0-SNAPSHOT.jar
Open http://localhost:8080 you can see the web pages to show the todo list app

Clean up

Delete the Azure resources you created by running the following command:

az group delete -y --no-wait -n <your-resource-group-name>

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Useful link

todo-app-java-on-azure's People

Contributors

Stargazers

Watchers

Forkers

artofcode7 kaylangan sureddy1 nageshkaranth eskibear egamma deepankarbhardwaj suhuruli mjrousos anithpv girneni thejusjoby ashgene bbenz matthew-dong yuwzho jeremyrickard ricec lastcoolnameleft selvasingh taeyo jastev akaroml danielhabenicht shrishrirang allxiao jdneo archangelsdy yweng113 bingosummer tomarchermsft sandeep1987elex ngocngv pfiene vschina hdya pietrobr kirkre sjwaight santoshkatageri adbarlow eozkurt jamestramel anoopswsib shpik manito9 weldon0405 vimal4david karan9744 sudheerchilaka mauruiz777 michelleloren abhinayagarwal brunoborges sanjeevkumar761 alex2gs akaidoragon cmrcode ketchuponmyketchup torumakabe anoopgawande jamesmackle giggio-samples gabriel-rcpereira harichandraprasadn pankaj05854 danielchui ashokmvbc jndirangu18 ndanl ejohn20 dario-boberek timmccauley jcluu hlltarakci bsaby mlongarai zakarym gazataeon gagankohli2000 cloudmelon blueoceandevops devandsecops 1181254 tatazoe librannk sougatadas19 omkarpatil09 satishsverma lucashigor jasonlicn unnatigore sjegannathansdge sabeehah123 parbhatrai montecuollo espi3030 emdollete priyakumari123 saquib-rashid-msft

todo-app-java-on-azure's Issues

Upgrade the Spring Boot from 1.5.x to 2.0.x for the master branch

README contents for deploying

README should contain distinct sections that cover the following:

Run the TODO App locally
Deploy to Azure Web Apps on Containers (Linux) - using Maven
Deploy to Azure Web Apps on Containers (Linux) - using IntelliJ
Deploy to Azure Web Apps on Containers (Linux) - using Eclipse
Deploy to Azure Web Apps on Containers (Linux) - using Jenkins
Deploy to Kubernetes in Azure Container Service - using Maven
Deploy to Kubernetes in Azure Container Service - using Jenkins

mvn wapper error

$ git clone [email protected]:Microsoft/todo-app-java-on-azure.git
$ cd todo-app-java-on-azure/
$ ./mvnw clean
Error: Could not find or load main class org.apache.maven.wrapper.MavenWrapperMain

Simpler folder structure for sample app

Suggest that we use one folder for all the classes. It is a simple app. Let's put everything in the same package name - com.microsoft.azure.sample.todoapp or something like that

Question in settings.xml

The solution works fine and able to push docker image into Azure Container Registry
Is there a way to inject below fields (id, username and password) from Jenkins --> Maven --> pom.xml/settings.xml ? In the perspective of operation/password security it will be useful to avoid below hardcoding.

put-your-docker-registry-url
put-your-docker-username
put-your-docker-key

put-your-email

Can't debug TODOApplication in java9 env

Steps To Reproduce

Clone code from https://github.com/Microsoft/todo-app-java-on-azure.git
Open the cloned project and verify .project and .classpath files and target folder are generated.
Open file todo-app-java-on-azure\src\main\resources\application.properties and replaces it with a test configuration
Set BP on TodoListController.java on addNewTodoItem(@requestbody TodoItem item) and main on TodoApplication.java
Press F5 choose java and F5 again to start debug, verify the BP on main is hit.
Press F5 to continue
Current Result

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

The AI sample branch needs to be updated to use App Insights Spring Boot starter

When the App Insights Spring Boot starter becomes available, the sample as shown in the AI branch should be updated accordingly.

UI incorrectly states successful creation

I have followed the instructions provided in the repo and everything appeared to be working correctly. I ran the mvn package, updated the credentials, ran java -jar target/todo-app-java-on-azure-1.0-SNAPSHOT.jar and then went to localhost:8080 and created a new item (which the UI said it completed).

Using the Data Explorer, I couldn't find any of the data. I then changed the credentials so that I knew that they'd be wrong and found that the app continued to say it would create/update items.

In short, the UI appears to be providing incorrect information by saying that it created the item successfully.

P.S. I even deleted the CosmosDB instance and it still claimed to successfully create the TODO item.

Add Gradle deploy code and README for Tomcat in App Service Linux

Assigned to @lenala

Can't debug TODO Application: Error Starting ApplicationContext

Platform: Mac & Linux

Repro steps:

Open the cloned project and verify .project and .classpath files and target folder are generated.
Open file todo-app-java-on-azure\src\main\resources\application.properties and replaces it with a test configuration
Set BP on TodoListController.java on addNewTodoItem(@requestbody TodoItem item) and main on TodoApplication.java
Press F5 choose java and F5 again to start debug, verify the BP on main is hit
Press F5 to continue

Result:

 :: Spring Boot ::        (v2.0.3.RELEASE)

[INFO] TodoApplication - Starting TodoApplication on vsunxi00101 with PID 8928 (C:\Users\testuser\Downloads\todo-app-java-on-azure-master\todo-app-java-on-azure-master\target\classes started by testuser in C:\Users\testuser\Downloads\todo-app-java-on-azure-master\todo-app-java-on-azure-master)

[INFO] TodoApplication - No active profile set, falling back to default profiles: default

[INFO] AnnotationConfigServletWebServerApplicationContext - Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@61c4eee0: startup date [Wed Oct 31 08:12:00 UTC 2018]; root of context hierarchy

[INFO] TomcatWebServer - Tomcat initialized with port(s): 8080 (http)

2018-10-31 08:12:04.826  INFO 8928 --- [           main] o.apache.catalina.core.StandardService   : Starting service [Tomcat]

2018-10-31 08:12:04.826  INFO 8928 --- [           main] org.apache.catalina.core.StandardEngine  : Starting Servlet Engine: Apache Tomcat/8.5.31

2018-10-31 08:12:04.841  INFO 8928 --- [ost-startStop-1] o.a.catalina.core.AprLifecycleListener   : The APR based Apache Tomcat Native library which allows optimal performance in production environments was not found on the java.library.path: [C:\Program Files\Java\jdk1.8.0_181\bin;C:\Windows\Sun\Java\bin;C:\Windows\system32;C:\Windows;C:\Program Files\Microsoft SDKs\Azure\Azure Dev Spaces CLI (Preview)\;C:\Program Files (x86)\Microsoft SDKs\Azure\CLI2\wbin;C:\Windows\system32;C:\Windows;C:\Windows\System32\Wbem;C:\Windows\System32\WindowsPowerShell\v1.0\;C:\Windows\System32\OpenSSH\;C:\Program Files\Java\jdk1.8.0_181\bin;C:\Program Files\Git\cmd;C:\Program Files\apache-maven-3.5.4\bin;C:\Users\testuser\AppData\Local\Microsoft\WindowsApps;;C:\Users\testuser\AppData\Local\Programs\Microsoft VS Code\bin;.]

2018-10-31 08:12:05.132  INFO 8928 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/]       : Initializing Spring embedded WebApplicationContext

[INFO] ContextLoader - Root WebApplicationContext: initialization completed in 4180 ms

[INFO] ServletRegistrationBean - Servlet dispatcherServlet mapped to [/]

[INFO] FilterRegistrationBean - Mapping filter: 'characterEncodingFilter' to: [/*]

[INFO] FilterRegistrationBean - Mapping filter: 'hiddenHttpMethodFilter' to: [/*]

[INFO] FilterRegistrationBean - Mapping filter: 'httpPutFormContentFilter' to: [/*]

[INFO] FilterRegistrationBean - Mapping filter: 'requestContextFilter' to: [/*]

[WARN] AnnotationConfigServletWebServerApplicationContext - Exception encountered during context initialization - cancelling refresh attempt: org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'todoListController': Unsatisfied dependency expressed through field 'todoItemRepository'; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'todoItemRepository': Unsatisfied dependency expressed through method 'setDocumentDbOperations' parameter 0; nested exception is org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'com.microsoft.azure.spring.data.cosmosdb.core.DocumentDbOperations' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {}

2018-10-31 08:12:05.606  INFO 8928 --- [           main] o.apache.catalina.core.StandardService   : Stopping service [Tomcat]

[INFO] ConditionEvaluationReportLoggingListener - 

Error starting ApplicationContext. To display the conditions report re-run your application with 'debug' enabled.

[ERROR] LoggingFailureAnalysisReporter - 

***************************

APPLICATION FAILED TO START

***************************

Description:

Parameter 0 of method setDocumentDbOperations in com.microsoft.azure.spring.data.cosmosdb.repository.support.DocumentDbRepositoryFactoryBean required a bean of type 'com.microsoft.azure.spring.data.cosmosdb.core.DocumentDbOperations' that could not be found.

Action:

Consider defining a bean of type 'com.microsoft.azure.spring.data.cosmosdb.core.DocumentDbOperations' in your configuration.

The sample in the AI branch needs to be updated to show tracking dependencies

The AI branch shows how to configure a Java Springboot application with Application Insights. Currently the sample is only configured to show requests\responses within the app - but, does not track HTTP requests\responses with dependencies.

The steps that need to be completed are described here: https://docs.microsoft.com/en-us/azure/application-insights/app-insights-java-agent. In particular, make sure that the agent jar and the AI-Agent.xml files are located next to one another. Also, when launching the app's jar, make sure that you include "-javaagent=".

This work cannot be completed right now because there is a bug that causes an exception to be thrown when attempting to start the app. When this issue is fixed, this sample needs to be updated accordingly to track dependencies: microsoft/ApplicationInsights-Java#506

"java" base image is deprecated

This project use 'java' as base image. But this image is deprecated in favor of openjdk. Please switch to openjdk instead.

More info on deprecation:
https://hub.docker.com/_/java/

potential NPE in TodoItem.equals method

https://github.com/Microsoft/todo-app-java-on-azure/blob/master/src/main/java/com/microsoft/azure/sample/model/TodoItem.java#L70

 final TodoItem itemA = new TodoItem();
 final TodoItem itemB = new TodoItem("B", "Item B", "Owner of Item B");

itemA.equals(itemB) throws NPE.