Skip to content

Commit da162ca

Browse files
frankynfrankyn
authored
Merge branch 'master' into update-migration-sample
2 parents d7b0b3d + 588be0f commit da162ca

File tree

22 files changed

+810
-17
lines changed

22 files changed

+810
-17
lines changed

‎README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Technology Samples:
1919
* [Bigquery](bigquery)
2020
* [Datastore](datastore)
2121
* [Endpoints](endpoints)
22+
* [Identity-Aware Proxy](iap)
2223
* [Key Management Service](kms)
2324
* [Logging](logging)
2425
* [Monitoring](monitoring)

‎appengine-java8/cloudsql/pom.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,15 @@
6969
</dependency>
7070

7171
<!-- [START dependencies] -->
72-
<dependency> <!-- ONLY USED LOCALY -->
72+
<dependency>
7373
<groupId>mysql</groupId>
7474
<artifactId>mysql-connector-java</artifactId>
75-
<version>5.1.40</version> <!-- v5.x.x is Java 7, v6.x.x is Java 8 -->
75+
<version>5.1.40</version> <!-- v5.x.x is for production, v6.x.x EAP X DevAPI and Java 8 -->
76+
<!--<version>6.0.6</version>-->
7677
</dependency>
7778
<dependency>
7879
<groupId>com.google.cloud.sql</groupId>
79-
<artifactId>mysql-socket-factory</artifactId>
80+
<artifactId>mysql-socket-factory</artifactId> <!-- mysql-socket-factory-connector-j-6 -->
8081
<version>1.0.2</version>
8182
</dependency>
8283
<!-- [END dependencies] -->

‎appengine-java8/cloudsql/src/main/webapp/WEB-INF/appengine-web.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@
1616
<threadsafe>true</threadsafe>
1717
<runtime>java8</runtime>
1818

19-
<use-google-connector-j>true</use-google-connector-j>
19+
<!-- <use-google-connector-j>true</use-google-connector-j> NO LONGER REQUIRED -->
2020
<system-properties>
21-
<property name="ae-cloudsql.cloudsql-database-url" value="jdbc:google:mysql://${INSTANCE_CONNECTION_NAME}/${database}?user=${user}&amp;password=${password}" />
22-
<property name="ae-cloudsql.local-database-url" value="jdbc:mysql://google/${database}?cloudSqlInstance=${INSTANCE_CONNECTION_NAME}&amp;socketFactory=com.google.cloud.sql.mysql.SocketFactory&amp;user=${user}&amp;password=${password}&amp;useSSL=false" />
21+
<property name="ae-cloudsql.cloudsql-database-url" value="jdbc:mysql://google/${database}?useSSL=false&amp;cloudSqlInstance=${INSTANCE_CONNECTION_NAME}&amp;socketFactory=com.google.cloud.sql.mysql.SocketFactory&amp;user=${user}&amp;password=${password}" />
22+
<property name="ae-cloudsql.local-database-url" value="jdbc:mysql://google/${database}?useSSL=false&amp;cloudSqlInstance=${INSTANCE_CONNECTION_NAME}&amp;socketFactory=com.google.cloud.sql.mysql.SocketFactory&amp;user=${user}&amp;password=${password}" />
2323
</system-properties>
2424
</appengine-web-app>
2525
<!-- [END config] -->

‎appengine/endpoints-frameworks-v2/backend/README.md

Lines changed: 92 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
This sample demonstrates how to use Google Cloud Endpoints Frameworks using
44
Java on App Engine Standard.
55

6-
## Adding the project ID to the sample API code
6+
## Build with Maven
7+
8+
### Adding the project ID to the sample API code
79

810
You must add the project ID obtained when you created your project to the
911
sample's `pom.xml` before you can deploy the code.
@@ -21,19 +23,19 @@ your project ID.
2123

2224
0. Save your changes.
2325

24-
## Building the sample project
26+
### Building the sample project
2527

2628
To build the project:
2729

2830
mvn clean package
2931

30-
## Generating the openapi.json file
32+
### Generating the openapi.json file
3133

3234
To generate the required configuration file `openapi.json`:
3335

3436
mvn exec:java -DGetSwaggerDoc
3537

36-
## Deploying the sample API to App Engine
38+
### Deploying the sample API to App Engine
3739

3840
To deploy the sample API:
3941

@@ -51,7 +53,92 @@ To deploy the sample API:
5153

5254
0. Wait for the upload to finish.
5355

54-
## Sending a request to the sample API
56+
### Sending a request to the sample API
57+
58+
After you deploy the API and its configuration file, you can send requests
59+
to the API.
60+
61+
To send a request to the API, from a command line, invoke the following `cURL`
62+
command:
63+
64+
curl \
65+
-H "Content-Type: application/json" \
66+
-X POST \
67+
-d '{"message":"echo"}' \
68+
https://$PROJECT_ID.appspot.com/_ah/api/echo/v1/echo
69+
70+
You will get a 200 response with the following data:
71+
72+
{
73+
"message": "echo"
74+
}
75+
76+
## Build with gradle
77+
78+
### Adding the project ID to the sample API code
79+
80+
0. Edit the file `build.gradle`.
81+
82+
0. For `def projectId = 'YOUR_PROJECT_ID'`, replace the value `YOUR_PROJECT_ID` with
83+
your project ID.
84+
85+
0. Edit the file `src/main/java/com/example/echo/Echo.java
86+
87+
0. Replace the value `YOUR-PROJECT-ID` with your project ID.
88+
89+
0. Save your changes.
90+
91+
### Building the sample project
92+
93+
To build the project use:
94+
95+
gradle build
96+
97+
<details>
98+
<summary>more details</summary>
99+
The project contains the standard java and war plugins and in addition to that it contains the following plugins:
100+
https://github.com/GoogleCloudPlatform/endpoints-framework-gradle-plugin for the endpoint related tasks and
101+
https://github.com/GoogleCloudPlatform/app-gradle-plugin for the appengine standard related tasks.
102+
103+
Check the links for details about the available Plugin Goals and Parameters.
104+
</details>
105+
106+
### Generating the openapi.json file
107+
108+
To generate the required configuration file `openapi.json`:
109+
110+
gradle endpointsOpenApiDocs
111+
112+
This results in a file in build/endpointsOpenApiDocs/openapi.json
113+
114+
### Deploying the sample API to App Engine
115+
116+
To deploy the sample API:
117+
118+
0. Invoke the `gcloud` command to deploy the API configuration file:
119+
120+
gcloud service-management deploy build/endpointsOpenApiDocs/openapi.json
121+
122+
0. Deploy the API implementation code by invoking:
123+
124+
gradle appengineDeploy
125+
126+
The first time you upload a sample app, you may be prompted to authorize the
127+
deployment. Follow the prompts: when you are presented with a browser window
128+
containing a code, copy it to the terminal window.
129+
130+
<details>
131+
<summary>ERROR: (gcloud.app.deploy) The current Google Cloud project [...] does not contain an App Engine application.</summary>
132+
If you create a fresh cloud project that doesn't contain a appengine application you may receive this Error:
133+
134+
ERROR: (gcloud.app.deploy) The current Google Cloud project [...] does not contain an App Engine application. Use `gcloud app create` to initialize an App Engine application within the project.
135+
136+
In that case just execute `gcloud app create`, you will be asked to select a region and the app will be created. Then run gradle appengineDeploy again.
137+
</details>
138+
139+
0. Wait for the upload to finish.
140+
141+
### Sending a request to the sample API
55142

56143
After you deploy the API and its configuration file, you can send requests
57144
to the API.

‎appengine/endpoints-frameworks-v2/backend/build.gradle

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
// Copyright 2017 Google Inc.
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// http://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.import org.apache.tools.ant.filters.ReplaceTokens
14+
15+
buildscript {
16+
repositories {
17+
mavenCentral()
18+
}
19+
20+
dependencies {
21+
classpath 'com.google.cloud.tools:endpoints-framework-gradle-plugin:+'
22+
classpath 'com.google.cloud.tools:appengine-gradle-plugin:+'
23+
}
24+
}
25+
26+
repositories {
27+
maven {
28+
url 'https://maven-central.storage.googleapis.com'
29+
}
30+
jcenter()
31+
mavenCentral()
32+
}
33+
34+
task wrapper(type: Wrapper) {
35+
gradleVersion = '3.5'
36+
}
37+
38+
def projectId = 'YOUR_PROJECT_ID'
39+
40+
apply plugin: 'java'
41+
apply plugin: 'war'
42+
apply plugin: 'com.google.cloud.tools.endpoints-framework-server'
43+
apply plugin: 'com.google.cloud.tools.appengine'
44+
45+
dependencies {
46+
// For real projects: use concrete versions here instead of the '+' to make your build consistent
47+
compile 'com.google.endpoints:endpoints-framework:+'
48+
compile 'com.google.endpoints:endpoints-management-control-appengine:+'
49+
compile 'com.google.endpoints:endpoints-framework-auth:+'
50+
}
51+
52+
endpointsServer {
53+
// Endpoints Framework Plugin server-side configuration
54+
hostname = "echo-api.endpoints.${projectId}.cloud.goog"
55+
}
56+
57+
sourceCompatibility = 1.7 // App Engine Standard uses Java 7
58+
targetCompatibility = 1.7 // App Engine Standard uses Java 7
59+
60+
// this replaces the ${endpoints.project.id} in appengine-web.xml and web.xml
61+
task replaceProjectId(type: Copy) {
62+
from 'src/main/webapp/WEB-INF/'
63+
include '*.xml'
64+
into 'build/exploded-backend/WEB-INF'
65+
expand(endpoints:[project:[id:projectId]])
66+
filteringCharset = 'UTF-8'
67+
}
68+
assemble.dependsOn replaceProjectId

‎appengine/iap/README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Cloud Identity-Aware Proxy sample for Google App Engine
2+
3+
This sample demonstrates how to use the [Cloud Identity-Aware Proxy][iap-docs] on [Google App
4+
Engine][ae-docs].
5+
6+
[iap-docs]: https://cloud.google.com/iap/docs/
7+
[ae-docs]: https://cloud.google.com/appengine/docs/java/
8+
9+
## Setup
10+
11+
Install the [Google Cloud SDK](https://cloud.google.com/sdk/) and run:
12+
```
13+
gcloud init
14+
```
15+
If this is your first time creating an App engine application:
16+
```
17+
gcloud app create
18+
```
19+
20+
## Running locally
21+
22+
This application depends on being enabled behind an IAP, so this program should not be run locally.
23+
24+
## Deploying
25+
26+
- Deploy the application to the project
27+
```
28+
mvn clean appengine:deploy
29+
```
30+
- [Enable](https://cloud.google.com/iap/docs/app-engine-quickstart) Identity-Aware Proxy on the App Engine app.
31+
- Add the email account you'll be running the test as to the Identity-Aware Proxy access list for the project.
32+
33+
## Test
34+
35+
Once deployed, access `https://your-project-id.appspot.com` . This should now prompt you to sign in for access.
36+
Sign in with the email account that was added to the Identity-Aware proxy access list.
37+
You should now see the jwt token that was received from the IAP server.

‎appengine/iap/pom.xml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!--
2+
Copyright 2017 Google Inc.
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
-->
16+
<project>
17+
<modelVersion>4.0.0</modelVersion>
18+
<packaging>war</packaging>
19+
<version>1.0-SNAPSHOT</version>
20+
<groupId>com.example.appengine</groupId>
21+
<artifactId>appengine-iap</artifactId>
22+
23+
<parent>
24+
<groupId>com.google.cloud</groupId>
25+
<artifactId>appengine-doc-samples</artifactId>
26+
<version>1.0.0</version>
27+
<relativePath>..</relativePath>
28+
</parent>
29+
<dependencies>
30+
<dependency>
31+
<groupId>javax.servlet</groupId>
32+
<artifactId>servlet-api</artifactId>
33+
<version>2.5</version>
34+
<scope>provided</scope>
35+
</dependency>
36+
</dependencies>
37+
<build>
38+
<!-- for hot reload of the web application -->
39+
<outputDirectory>${project.build.directory}/${project.build.finalName}/WEB-INF/classes</outputDirectory>
40+
<plugins>
41+
<plugin>
42+
<groupId>org.apache.maven.plugins</groupId>
43+
<version>3.3</version>
44+
<artifactId>maven-compiler-plugin</artifactId>
45+
<configuration>
46+
<source>1.7</source>
47+
<target>1.7</target>
48+
</configuration>
49+
</plugin>
50+
<plugin>
51+
<groupId>com.google.cloud.tools</groupId>
52+
<artifactId>appengine-maven-plugin</artifactId>
53+
<version>1.3.1</version>
54+
</plugin>
55+
</plugins>
56+
</build>
57+
</project>

‎appengine/iap/src/main/java/com/example/appengine/iap/JwtServlet.java

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/**
2+
* Copyright 2017 Google Inc.
3+
*
4+
* <p>Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
5+
* except in compliance with the License. You may obtain a copy of the License at
6+
*
7+
* <p>http://www.apache.org/licenses/LICENSE-2.0
8+
*
9+
* <p>Unless required by applicable law or agreed to in writing, software distributed under the
10+
* License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
11+
* express or implied. See the License for the specific language governing permissions and
12+
* limitations under the License.
13+
*/
14+
package com.example.appengine.iap;
15+
16+
import java.io.IOException;
17+
import javax.servlet.http.HttpServlet;
18+
import javax.servlet.http.HttpServletRequest;
19+
import javax.servlet.http.HttpServletResponse;
20+
21+
/**
22+
* Identity Aware Proxy (IAP) Test application to reflect jwt token issued by IAP. IAP must be
23+
* enabled on application. {@see https://cloud.google.com/iap/docs/app-engine-quickstart}
24+
*/
25+
@SuppressWarnings("serial")
26+
public class JwtServlet extends HttpServlet {
27+
28+
private static final String IAP_JWT_HEADER = "x-goog-authenticated-user-jwt";
29+
30+
@Override
31+
public void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
32+
resp.getWriter().print(IAP_JWT_HEADER + ":" + req.getHeader(IAP_JWT_HEADER));
33+
}
34+
}

‎appengine/iap/src/main/webapp/WEB-INF/appengine-web.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!--
3+
Copyright 2017 Google Inc.
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
http://www.apache.org/licenses/LICENSE-2.0
8+
Unless required by applicable law or agreed to in writing, software
9+
distributed under the License is distributed on an "AS IS" BASIS,
10+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11+
See the License for the specific language governing permissions and
12+
limitations under the License.
13+
-->
14+
<appengine-web-app xmlns="http://appengine.google.com/ns/1.0">
15+
<threadsafe>true</threadsafe>
16+
</appengine-web-app>

0 commit comments

Comments
 (0)