Merge pull request #94 from GoogleCloudPlatform/cloud-sql-flex-updates

Update AppEngine CloudSQL second generation sample

Author: remi Taylor

.travis.yml

@@ -39,6 +39,7 @@ env:
   - TEST_DIR=translate
   - TEST_DIR=language
   - TEST_DIR=appengine/endpoints
+  - TEST_DIR=appengine/cloudsql
   - TEST_DIR=vision
 
 before_install:

appengine/analytics/spec/google_analytics_spec.rb

@@ -19,7 +19,7 @@
 
 Capybara.current_driver = :poltergeist
 
-RSpec.describe "Google Analytics on Google App Engine", type: :feature do
+describe "Google Analytics on Google App Engine", type: :feature do
   before :all do
     @url = E2E.url
   end

appengine/cloudsql/.rspec

@@ -0,0 +1 @@
+--tty --color --format documentation --order random

appengine/cloudsql/Gemfile

@@ -12,17 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# [START dependencies]
 source "https://rubygems.org"
 
-# [START dependencies]
 gem "mysql2"
+gem "sequel"
 # [END dependencies]
 
 gem "sinatra"
-gem "sequel"
 
 group :test do
   gem "rspec"
   gem "capybara"
   gem "poltergeist"
+  gem "rack-test"
+  gem "sqlite3"
 end

appengine/cloudsql/Gemfile.lock

@@ -47,6 +47,7 @@ GEM
       rack (~> 1.5)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
+    sqlite3 (1.3.12)
     tilt (2.0.5)
     websocket-driver (0.6.4)
       websocket-extensions (>= 0.1.0)
@@ -61,9 +62,11 @@ DEPENDENCIES
   capybara
   mysql2
   poltergeist
+  rack-test
   rspec
   sequel
   sinatra
+  sqlite3
 
 BUNDLED WITH
-   1.12.5
+   1.13.3

appengine/cloudsql/README.md

@@ -15,7 +15,7 @@ SDK use the following command:
             --activation-policy=ALWAYS \
             --tier=db-n1-standard-1
 
-    where `[YOUR_INSTANCE_NAME]` is a name of your choice.
+    where `[YOUR_INSTANCE_NAME]` is a name of your choice, composed of lowercase letters, numbers, and hyphens; must start with a letter.
 
 1. Set the root password on your Cloud SQL instance:
 
@@ -57,7 +57,11 @@ create a [new user][user] and [database][database] for your application:
 `MYSQL_DATABASE` environment variables. This allows the app to connect to your
 Cloud SQL instance through the proxy.
 
-1. Update the values in in `app.yaml` with your instance configuration.
+1. Update the values in `app.yaml` with your instance configuration.
+
+1. Install dependencies
+
+    bundle install
 
 1. Finally, run `create_tables.rb` to ensure that the database is properly
 configured and to create the tables needed for the sample.

appengine/cloudsql/app.rb

@@ -17,23 +17,24 @@
 require "sinatra"
 require "sequel"
 
-# [START connect]
 DB = Sequel.mysql2 user:     ENV["MYSQL_USER"],
                    password: ENV["MYSQL_PASSWORD"],
                    database: ENV["MYSQL_DATABASE"],
                    socket:   ENV["MYSQL_SOCKET_PATH"]
-# [END connect]
 
 get "/" do
+  # Store a hash of the visitor's ip address
+  visitor_ip = Digest::SHA256.hexdigest request.ip
+
   # Save visit in database
-  DB[:visits].insert(
-    user_ip:   Digest::SHA256.hexdigest(request.ip),
-    timestamp: Time.now
-  )
+  DB[:visits].insert user_ip: visitor_ip, timestamp: Time.now
+
+  # Retrieve the latest 10 visit records from the database
+  visits = DB[:visits].limit(10).order Sequel.desc(:timestamp)
 
   response.write "Last 10 visits:\n"
 
-  DB[:visits].order(Sequel.desc(:timestamp)).limit(10).each do |visit|
+  visits.each do |visit|
     response.write "Time: #{visit[:timestamp]} Addr: #{visit[:user_ip]}\n"
   end
 

appengine/cloudsql/create_tables.rb

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# [START all]
 require "sequel"
 
 DB = Sequel.mysql2 user:     ENV["MYSQL_USER"],
@@ -25,4 +24,3 @@
   String      :user_ip
   Time        :timestamp
 end
-# [END all]

appengine/cloudsql/spec/cloudsql_spec.rb

@@ -12,33 +12,43 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require File.expand_path("../../../../spec/e2e", __FILE__)
+require_relative "../app.rb"
 require "rspec"
-require "capybara/rspec"
-require "capybara/poltergeist"
+require "rack/test"
 
-Capybara.current_driver = :poltergeist
+describe "Cloud SQL sample", type: :feature do
+  include Rack::Test::Methods
 
-RSpec.describe "Cloud SQL on Google App Engine", type: :feature do
-  before :all do
-    app_yaml = File.expand_path("../../app.yaml", __FILE__)
+  def app
+    Sinatra::Application
+  end
+
+  before do
+    @database = Sequel.sqlite database: ":memory:"
+
+    expect(Sequel).to receive(:mysql2).and_return @database
+  end
 
-    configuration = File.read(app_yaml)
-    configuration.sub! "[YOUR_USER]",        ENV["MYSQL_USER"]
-    configuration.sub! "[YOUR_PASSWORD]",    ENV["MYSQL_PASSWORD"]
-    configuration.sub! "[YOUR_DATABASE]",    ENV["MYSQL_DATABASE"]
-    configuration.sub! "[YOUR_SOCKET_PATH]", ENV["MYSQL_SOCKET_PATH"]
+  it "can create database schema by running create_tables.rb" do
+    expect(@database.tables).not_to include :visits
 
-    File.write(app_yaml, configuration)
+    load File.expand_path("../create_tables.rb", __dir__)
 
-    @url = E2E.url
+    expect(@database.tables).to include :visits
   end
 
-  it "displays recent visits" do
-    2.times { visit @url }
+  it "displays hashes of the IP addresses of the top 10 most recent visits" do
+    load File.expand_path("../create_tables.rb", __dir__)
+    expect(@database[:visits].count).to eq 0
+
+    localhost_user_ip = Digest::SHA256.hexdigest "127.0.0.1"
+
+    15.times { get "/" }
 
-    expect(page).to have_content "Last 10 visits:"
-    expect(page).to have_content "Time:"
-    expect(page).to have_content "Addr:"
+    expect(@database[:visits].count).to eq 15
+    expect(@database[:visits].first[:user_ip]).to eq localhost_user_ip
+    expect(last_response.body).to include "Last 10 visits"
+    expect(last_response.body).to include "Addr: #{localhost_user_ip}"
+    expect(last_response.body.scan("Addr:").count).to eq 10
   end
 end

appengine/cloudsql/spec/end_to_end_spec.rb

@@ -0,0 +1,46 @@
+# Copyright 2016 Google, Inc
+#
+# 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.
+
+require File.expand_path("../../../../spec/e2e", __FILE__)
+require "rspec"
+require "capybara/rspec"
+require "capybara/poltergeist"
+
+Capybara.current_driver = :poltergeist
+
+describe "Cloud SQL on Google App Engine", type: :feature do
+  before :all do
+    skip "End-to-end tests skipped" unless E2E.run?
+
+    app_yaml = File.expand_path("../../app.yaml", __FILE__)
+
+    configuration = File.read(app_yaml)
+    configuration.sub! "[YOUR_USER]",        ENV["MYSQL_USER"]
+    configuration.sub! "[YOUR_PASSWORD]",    ENV["MYSQL_PASSWORD"]
+    configuration.sub! "[YOUR_DATABASE]",    ENV["MYSQL_DATABASE"]
+    configuration.sub! "[YOUR_SOCKET_PATH]", ENV["MYSQL_SOCKET_PATH"]
+
+    File.write(app_yaml, configuration)
+
+    @url = E2E.url
+  end
+
+  it "displays recent visits" do
+    2.times { visit @url }
+
+    expect(page).to have_content "Last 10 visits:"
+    expect(page).to have_content "Time:"
+    expect(page).to have_content "Addr:"
+  end
+end