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 list recommendations code sample #1789

Merged
merged 9 commits into from
Dec 7, 2019
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions recommender/beta/cloud-client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Getting Started with Recommender and the Google Java API Client library

<a href="https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/java-docs-samples&page=editor&open_in_editor=README.md&cloudshell_working_dir=recommender/beta/cloud-client/">
<img alt="Open in Cloud Shell" src ="http://gstatic.com/cloudssh/images/open-btn.png"></a>

[Cloud Recommender](https://cloud.google.com/recommender/) is a service on Google Cloud that provides
usage recommendations for Cloud products and services. This sample Java
application demonstrates how to access the Recommender API using the
[Google Cloud Client Library for Java](https://github.com/GoogleCloudPlatform/google-cloud-java).

## Quickstart

### Setup
- [Set up a Java Development Environment for Maven](https://cloud.google.com/java/docs/setup).
- [Enable Recommender API](https://cloud.google.com/recommender/docs/enabling) for your project.
- [Authenticate using a service account](https://cloud.google.com/docs/authentication/getting-started).
Create a service account, download a JSON key file, and set the
`GOOGLE_APPLICATION_CREDENTIALS` environment variable.
- Set the `GOOGLE_CLOUD_PROJECT` environment variable to your project ID.

### Build
Build your project with:
```
mvn clean package -DskipTests
```

### List Recommendations
To list IAM recommendations for your project:
```
mvn exec:java -Dexec.mainClass=com.example.recommender.ListRecommendations
```

## Testing
To run the unit tests:
```
mvn clean verify
```
86 changes: 86 additions & 0 deletions recommender/beta/cloud-client/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!--
Copyright 2019 Google LLC
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<project>
<modelVersion>4.0.0</modelVersion>
<groupId>com.example.recommender</groupId>
<artifactId>recommender-samples</artifactId>
<packaging>jar</packaging>

<!--
The parent pom defines common style checks and testing strategies for our samples.
Removing or replacing it should not affect the execution of the samples in anyway.
-->
<parent>
<groupId>com.google.cloud.samples</groupId>
<artifactId>shared-configuration</artifactId>
<version>1.0.11</version>
</parent>

<properties>
<maven.compiler.target>1.8</maven.compiler.target>
<maven.compiler.source>1.8</maven.compiler.source>
</properties>

<!-- [START recommender_java_dependencies] -->
<!-- Using libraries-bom to manage versions.
See https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM -->
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>3.0.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-recommender</artifactId>
<version>0.1.2</version>
</dependency>
<!-- [END recommender_java_dependencies] -->

<!-- Test dependencies -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.truth</groupId>
<artifactId>truth</artifactId>
<version>1.0</version>
<scope>test</scope>
</dependency>
<!-- [START recommender_java_dependencies] -->
</dependencies>
<!-- [END recommender_java_dependencies] -->

<build>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.6.0</version>
<configuration>
<cleanupDaemonThreads>false</cleanupDaemonThreads>
</configuration>
</plugin>
</plugins>
</build>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.recommender;

// [START recommender_list_recommendations]

import com.google.cloud.recommender.v1beta1.ListRecommendationsRequest;
import com.google.cloud.recommender.v1beta1.Recommendation;
import com.google.cloud.recommender.v1beta1.RecommenderClient;
import java.io.IOException;

public class ListRecommendations {

// List IAM recommendations for GOOGLE_CLOUD_PROJECT environment variable
public static void listRecommendations() throws IOException {
String projectId = System.getenv("GOOGLE_CLOUD_PROJECT");
Copy link
Contributor

Choose a reason for hiding this comment

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

Assume the user wants to edit inline and run from IDE:

Suggested change
String projectId = System.getenv("GOOGLE_CLOUD_PROJECT");
// TODO(developer): Replace these variables before running the sample.
String projectId = "my-project-id";

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


// Supported Google Cloud locations can be found at
// https://cloud.google.com/compute/docs/regions-zones/
String location = "global";

// Supported recommenders can be found at
// https://cloud.google.com/recommender/docs/recommenders#recommenders
String recommender = "google.iam.policy.Recommender";

listRecommendations(projectId, location, recommender);
}

// List recommendations for a specified project, location, and recommender
public static void listRecommendations(String projectId, String location, String recommender)
throws IOException {
RecommenderClient recommenderClient = RecommenderClient.create();
Copy link
Contributor

Choose a reason for hiding this comment

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

Please enclose with a try-with-resources and add the comment from the Sample Format guide regarding using .close():

// Initialize client that will be used to send requests. This client only needs to be created
// once, and can be reused for multiple requests. After completing all of your requests, call
// the "close" method on the client to safely clean up any remaining background resources.
try (DlpServiceClient dlp = DlpServiceClient.create()) {
  // Do something
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.


/// Build the request
String parent =
String.format(
"projects/%s/locations/%s/recommenders/%s", projectId, location, recommender);
ListRecommendationsRequest request =
ListRecommendationsRequest.newBuilder().setParent(parent).build();

// Send the request and print out each recommendation
for (Recommendation responseItem :
Copy link
Contributor

Choose a reason for hiding this comment

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

This looks better, but please separate out the call from the iteration to make more clear. Often users are unsure when the API call actually happens with built requests, so it's helpful to be specific:

// Send the request to the service and receive the response
List<Recommendation> response = recommenderClient.listRecommendations(request);

// Print each recommendation
for (Recommendation recommendation : response.iterateAll()) {
  // ...
}
System.out.println("List recommendations successful");

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Separated out the request from the print loop.

recommenderClient.listRecommendations(request).iterateAll()) {
Recommendation recommendation = responseItem;
System.out.println("Recommendation name: " + recommendation.getName());
System.out.println("- description: " + recommendation.getDescription());
System.out.println(
"- primary_impact.category: " + recommendation.getPrimaryImpact().getCategory());
System.out.println("- state_info.state: " + recommendation.getStateInfo().getState());
System.out.println();
}

// Indicate the request was successful
System.out.println("List recommendations successful");
}

public static void main(String... args) throws IOException {
Copy link
Contributor

Choose a reason for hiding this comment

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

Should exclude main altogether - users can run the snippet by replacing the variables in the no-arg function call and triggering themselves.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done, also removed option to run from main in the readme.

listRecommendations();
}
}
// [END recommender_list_recommendations]
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package com.example.recommender;

import static com.google.common.truth.Truth.assertThat;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.PrintStream;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

public class ListRecommendationsTest {

private ByteArrayOutputStream bout;
private PrintStream out;

@Before
public void setUp() throws Exception {
bout = new ByteArrayOutputStream();
out = new PrintStream(bout);
System.setOut(out);
}

@After
public void tearDown() {
System.setOut(null);
}

@Test
public void listRecommendations() throws IOException {
ListRecommendations.listRecommendations();
Copy link
Contributor

Choose a reason for hiding this comment

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

You'll need to update to listRecommendations(String projectId, String location, String recommender) - When move the env vars to this side, make sure to throw an error if they aren't there. See this example.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated and added env var checks.


assertThat(bout.toString()).contains("List recommendations successful");
}
}