Devadv 1645 improve and fix current java springboot tutorial (#5)

* Change tests from unit tests to integration tests. This prevents the mvn package from crashing when not running Couchbase Server locally.

* Code cleanup: removal of unused code/imports etc.

* Various code improvements. Adapt Swagger codes and exception catching to match actual behaviour. Documentation fixes. Change bucket name to not conflict with other Couchbase tutorials. Remove unneeded imports.

* Add MIT license.

Author: nebasuke

LICENSE.md

@@ -0,0 +1,9 @@
+# Released under MIT License
+
+Copyright (c) 2021 Couchbase, Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -9,9 +9,10 @@ Full documentation can be found on the [Couchbase Developer Portal](https://deve
 ## Prerequisites
 To run this prebuilt project, you will need:
 
-- Couchbase 7 Installed (version 7.0.0-5247 or higher)
+- Couchbase Server 7 Installed (version 7.0.0-5247 or higher)
 - Java SDK v1.8 or higher installed 
 - Code Editor installed (IntelliJ IDEA, Eclipse, or Visual Studio Code)
+- Maven command line
 
 ## Install Dependencies 
 
@@ -23,7 +24,7 @@ mvn package
 
 ### Database Server Configuration
 
-All configuration for communication with the database is stored in the `/src/main/java/resources/application.properties` file.  This includes the connection string, username, and password.  The default username is assumed to be `Administrator` and the default password is assumed to be `password`.  If these are different in your environment you will need to change them before running the application.
+All configuration for communication with the database is stored in the `/src/main/resources/application.properties` file.  This includes the connection string, username, and password.  The default username is assumed to be `Administrator` and the default password is assumed to be `password`.  If these are different in your environment you will need to change them before running the application.
 
 ### Dependency Injection via DBSetupRunner class 
 
@@ -41,19 +42,17 @@ You can launch your browser and go to the [Swagger start page](https://localhost
 
 ## Running The Tests
 
-To run the standard integration tests, use the following commands:
-
-To run the standard integration tests, use the following commands:
+To run the standard integration tests (which requires a running Couchbase Server), use the following command:
 
 ```sh
-mvn test
+mvn verify
 ```
 
 ## Project Setup Notes
 
-This project was based on the standard [Spring Boot project](https://spring.io/guides/gs/rest-service/).  The HealthCheckController is provided as a santity check and is used in unit tests.  
+This project was based on the standard [Spring Boot project](https://spring.io/guides/gs/rest-service/).  The HealthCheckController is provided as a sanity check and is used in integration tests.  
 
-A fully list of packages are referenced in the pom.xml file
+A full list of packages are referenced in the pom.xml file
 
 ## Conclusion
 

pom.xml

@@ -79,7 +79,7 @@
         <dependency>
             <groupId>org.mindrot</groupId>
             <artifactId>jbcrypt</artifactId>
-            <version>0.3m</version>
+            <version>0.4</version>
         </dependency>
         <dependency>
             <groupId>org.junit.jupiter</groupId>
@@ -101,9 +101,57 @@
 
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.2</version>
+                <configuration>
+                    <excludes>
+                        <exclude>**/*IntegrationTest.java</exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-maven-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>pre-integration-test</id>
+                        <goals>
+                            <goal>start</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>post-integration-test</id>
+                        <goals>
+                            <goal>stop</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>3.0.0-M5</version>
+                <configuration>
+                    <includes>
+                        <include>**/*IntegrationTest.java</include>
+                    </includes>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>integration-tests</id>
+                        <goals>
+                            <goal>integration-test</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>verify</id>
+                        <goals>
+                            <goal>verify</goal>
+                        </goals>
+                    </execution>
+                </executions>
             </plugin>
         </plugins>
     </build>

src/main/java/org/couchbase/quickstart/configs/CouchbaseConfig.java

@@ -9,7 +9,6 @@
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.stereotype.Component;
 
 @Configuration
 public class CouchbaseConfig {
@@ -25,8 +24,8 @@ public Cluster getCouchbaseCluster(){
     @Bean
     public Bucket getCouchbaseBucket(Cluster cluster){
 
-        //Creates the cluster if it does not exist yet
-        if( !cluster.buckets().getAllBuckets().containsKey(dbProp.getBucketName())) {
+        // Creates the cluster if it does not exist yet
+        if (!cluster.buckets().getAllBuckets().containsKey(dbProp.getBucketName())) {
             cluster.buckets().createBucket(
                 BucketSettings.create(dbProp.getBucketName())
                     .bucketType(BucketType.COUCHBASE)

src/main/java/org/couchbase/quickstart/configs/Swagger.java

@@ -1,6 +1,5 @@
 package org.couchbase.quickstart.configs;
 
-import org.couchbase.quickstart.Application;
 import org.couchbase.quickstart.controllers.ProfileController;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -11,7 +10,6 @@
 import springfox.documentation.builders.RequestHandlerSelectors;
 
 @Configuration
-
 public class Swagger {
     @Bean
     public Docket api() {

src/main/java/org/couchbase/quickstart/controllers/IndexController.java

@@ -1,30 +1,27 @@
 package org.couchbase.quickstart.controllers;
 
+import com.couchbase.client.core.error.DocumentNotFoundException;
 import com.couchbase.client.java.Bucket;
 import com.couchbase.client.java.Cluster;
 import com.couchbase.client.java.Collection;
-import com.couchbase.client.java.json.JsonObject;
 import com.couchbase.client.java.query.QueryScanConsistency;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.annotations.ApiResponse;
 import io.swagger.annotations.ApiResponses;
-import static org.couchbase.quickstart.configs.CollectionNames.PROFILE;
-
-import org.couchbase.quickstart.configs.CollectionNames;
 import org.couchbase.quickstart.configs.DBProperties;
 import org.couchbase.quickstart.models.Profile;
 import org.couchbase.quickstart.models.ProfileRequest;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.*;
-import static com.couchbase.client.java.query.QueryOptions.queryOptions;
-
 
-import java.util.ArrayList;
 import java.util.List;
 import java.util.UUID;
 
+import static com.couchbase.client.java.query.QueryOptions.queryOptions;
+import static org.couchbase.quickstart.configs.CollectionNames.PROFILE;
+
 @RestController
 @RequestMapping("/api/v1/profile")
 public class ProfileController {
@@ -46,52 +43,58 @@ public ProfileController(Cluster cluster, Bucket bucket, DBProperties dbProperti
     @ApiOperation(value = "Create a user profile from the request")
     @ApiResponses({
             @ApiResponse(code = 201, message = "Created", response = Profile.class),
+            @ApiResponse(code = 400, message = "Bad request", response = Error.class),
             @ApiResponse(code = 500, message = "Internal Server Error", response = Error.class)
     })
     public ResponseEntity<Profile> save(@RequestBody final ProfileRequest userProfile) {
         //generates an id and save the user
         Profile profile = userProfile.getProfile();
-        profileCol.insert(profile.getPid(), profile);
-        return ResponseEntity.status(HttpStatus.CREATED).body(profile);
+
+        try {
+            profileCol.insert(profile.getPid(), profile);
+            return ResponseEntity.status(HttpStatus.CREATED).body(profile);
+        } catch (Exception e) {
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
+        }
     }
 
     @CrossOrigin(value="*")
     @GetMapping(path = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
-    @ApiOperation(value = "Get a user profile by Id", produces = MediaType.APPLICATION_JSON_VALUE)
+    @ApiOperation(value = "Get a user profile by id", produces = MediaType.APPLICATION_JSON_VALUE)
     @ApiResponses(
             value = {
                     @ApiResponse(code = 200, message = "OK"),
                     @ApiResponse(code = 500, message = "Error occurred in getting user profiles", response = Error.class)
             })
-    public ResponseEntity<Profile> getProfile(@RequestParam String pid) {
-        Profile profile = profileCol.get(pid).contentAs(Profile.class);
+    public ResponseEntity<Profile> getProfile(@PathVariable("id") UUID id) {
+        Profile profile = profileCol.get(id.toString()).contentAs(Profile.class);
         return ResponseEntity.status(HttpStatus.OK).body(profile);
     }
 
     @CrossOrigin(value="*")
     @PutMapping(path = "/{id}")
     @ApiOperation(value = "Update a user profile", response = Profile.class)
     @ApiResponses({
-            @ApiResponse(code = 200, message = "Updated the user profile", response = Profile.class),
-            @ApiResponse(code = 404, message = "user profile not found", response = Error.class),
-            @ApiResponse(code = 500, message = "returns internal server error", response = Error.class)
+            @ApiResponse(code = 201, message = "Updated the user profile", response = Profile.class),
+            @ApiResponse(code = 404, message = "User profile not found", response = Error.class),
+            @ApiResponse(code = 500, message = "Internal Server Error", response = Error.class)
     })
-    public ResponseEntity<Profile> update( @PathVariable("id") String id, @RequestBody Profile profile) {
-
+    public ResponseEntity<Profile> update(@PathVariable("id") UUID id, @RequestBody Profile profile) {
         try {
-            profileCol.upsert(id, profile);
+            profileCol.replace(id.toString(), profile);
             return ResponseEntity.status(HttpStatus.CREATED).body(profile);
+        } catch (DocumentNotFoundException dnfe) {
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
         } catch (Exception e){
-            return ResponseEntity.status(HttpStatus.EXPECTATION_FAILED).body(null);
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
         }
     }
 
     @CrossOrigin(value="*")
     @DeleteMapping(path = "/{id}")
-    @ApiOperation(value = "Delete a Users Profile")
+    @ApiOperation(value = "Delete a user profile")
     @ApiResponses({
             @ApiResponse(code = 200, message = "OK"),
-            @ApiResponse(code = 401, message = "Unauthorized", response = Error.class),
             @ApiResponse(code = 404, message = "Not Found", response = Error.class),
             @ApiResponse(code = 500, message = "Internal Server Error", response = Error.class)
     })
@@ -100,8 +103,10 @@ public ResponseEntity delete(@PathVariable UUID id){
         try {
             profileCol.remove(id.toString());
             return ResponseEntity.status(HttpStatus.OK).body(null);
+        } catch (DocumentNotFoundException dnfe) {
+            return ResponseEntity.status(HttpStatus.NOT_FOUND).body(null);
         } catch (Exception e){
-            return ResponseEntity.status(HttpStatus.EXPECTATION_FAILED).body(null);
+            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(null);
         }
     }
 

src/main/java/org/couchbase/quickstart/controllers/ProfileController.java

@@ -15,7 +15,7 @@
 
 
 /**
- * This class run after the application startup. It automatically setup all indexes needed
+ * This class run after the application startup. It automatically sets up all needed indexes
  */
 @Component
 public class DBSetupRunner implements CommandLineRunner {
@@ -34,7 +34,6 @@ public void run(String... args) {
             System.out.println("Created primary index" + props.getBucketName());
         } catch (Exception e) {
             System.out.println("Primary index already exists on bucket "+props.getBucketName());
-            e.printStackTrace();
         }
 
         CollectionManager collectionManager = bucket.collections();
@@ -71,8 +70,4 @@ public void run(String... args) {
           System.out.println(String.format("Failed to create secondary index on profile.firstName: %s", e.getMessage()));
         }
     }
-//
-//    private QueryResult createCollectionIndex() throws Exception {
-//        return cluster.query("CREATE PRIMARY INDEX default_profile_index ON "+props.getBucketName()+"._default."+ CollectionNames.PROFILE);
-//    }
 }

src/main/java/org/couchbase/quickstart/models/ProfileList.java

@@ -1,4 +1,4 @@
 spring.couchbase.bootstrap-hosts=localhost
-spring.couchbase.bucket.name=user_profile
+spring.couchbase.bucket.name=user_profile_spring
 spring.couchbase.bucket.user=Administrator
 spring.couchbase.bucket.password=password