Initial Stackdriver Logging sample specs

Author: remi Taylor

logging/sample.rb

@@ -41,7 +41,7 @@ def create_log_sink
   gcloud  = Gcloud.new "my-gcp-project-id"
   logging = gcloud.logging
   storage = gcloud.storage
-  bucket = storage.create_bucket "my-logs-bucket"
+  bucket  = storage.create_bucket "my-logs-bucket"
 
   # Grant owner permission to Cloud Logging service
   email = "cloud-logs@google.com"
@@ -58,10 +58,11 @@ def update_log_sink
   gcloud  = Gcloud.new "my-gcp-project-id"
   logging = gcloud.logging
   storage = gcloud.storage
-  bucket  = storage.bucket "my-logs-bucket"
+  bucket  = storage.bucket "new-destination-bucket"
+  sink    = logging.sink "my-sink"
 
-  sink = logging.sink "my-sink"
   sink.destination = "storage.googleapis.com/#{bucket.id}"
+
   sink.save
   # [END update_log_sink]
 end
@@ -134,5 +135,3 @@ def write_log_entry_using_ruby_logger
   logger.info "Log message"
   # [END write_log_entry_using_ruby_logger]
 end
-
-write_log_entry_using_ruby_logger

logging/spec/sample_spec.rb

@@ -14,6 +14,216 @@
 
 require_relative "../sample"
 require "rspec"
+require "gcloud"
 
 describe "Logging sample" do
+  before :all do
+    @gcloud  = Gcloud.new ENV["GCLOUD_PROJECT"]
+    @logging = @gcloud.logging
+    @storage = @gcloud.storage
+    @bucket  = @storage.bucket ENV["GCLOUD_PROJECT"]
+  end
+
+  before :each do
+    cleanup!
+    allow(Gcloud).to receive(:new).and_call_original
+    allow(Gcloud).to receive(:new).with("my-gcp-project-id").and_return(@gcloud)
+    allow(@gcloud).to receive(:logging).and_return(@logging)
+    allow(@gcloud).to receive(:storage).and_return(@storage)
+    allow(@storage).to receive(:bucket).with("my-logs-bucket").and_return(@bucket)
+    allow(@storage).to receive(:create_bucket).and_return(@bucket)
+  end
+
+  def cleanup!
+    @logging.sink("my-sink")&.delete
+  end
+
+  it "can create logging client" do
+    expect(create_logging_client).to be_a Gcloud::Logging::Project
+    expect(create_logging_client.project).to eq ENV["GCLOUD_PROJECT"]
+  end
+
+  it "can list log sinks" do
+    expect { list_log_sinks }.not_to output(/my-sink/).to_stdout
+
+    create_log_sink
+
+    expect { list_log_sinks }.to output(/my-sink/).to_stdout
+  end
+
+  it "can create log sink" do
+    expect(@logging.sink "my-sink").to be nil
+    
+    create_log_sink
+
+    expect(@logging.sink "my-sink").not_to be nil
+  end
+
+  it "can update log sink" do
+    different_bucket = Gcloud.new.storage.bucket ENV["ALTERNATE_BUCKET"]
+    allow(@storage).to receive(:bucket).with("new-destination-bucket").
+                       and_return(different_bucket)
+
+    create_log_sink
+
+    expect(@logging.sink("my-sink").destination).to eq(
+      "storage.googleapis.com/#{@bucket.id}"
+    )
+    expect(@logging.sink("my-sink").destination).not_to eq(
+      "storage.googleapis.com/#{different_bucket.id}"
+    )
+
+    update_log_sink
+
+    expect(@logging.sink("my-sink").destination).not_to eq(
+      "storage.googleapis.com/#{@bucket.id}"
+    )
+    expect(@logging.sink("my-sink").destination).to eq(
+      "storage.googleapis.com/#{different_bucket.id}"
+    )
+  end
+
+  it "can delete log sink" do
+    create_log_sink
+
+    expect { list_log_sinks }.to output(/my-sink/).to_stdout
+
+    delete_log_sink
+
+    expect { list_log_sinks }.not_to output(/my-sink/).to_stdout
+  end
+
+  it "can list log entries" do
+    # TODO move to constant
+    # TODO move log name to constant as well
+    project_id = ENV["GCLOUD_PROJECT"]
+
+    write_log_entry
+
+    # Wait for entry to be queryable
+    sleep 3
+
+    # Sample queries for entries for "gae_app" resources.
+    # The test project may not have App Engine resources.
+    # Instead, add a project log entry and change the filter string called.
+    allow(@logging).to receive(:entries).
+      with(filter: %{resource.type = "gae_app"}).
+      and_wrap_original do |m, *args|
+        m.call(
+          filter: %{logName = "projects/#{project_id}/logs/my_application_log"},
+          order: "timestamp desc"
+        )
+    end
+
+    timestamp = "\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2} [^\\\\]+"
+    log_name  = "projects/#{project_id}/logs/my_application_log"
+    payload   = '"Log message"'
+
+    expect { list_log_entries }.to output(
+      %r{\[#{timestamp}\] #{log_name} #{payload}}
+    ).to_stdout
+  end
+
+  it "can write log entry" do
+    project_id = ENV["GCLOUD_PROJECT"]
+    current_time = Time.now.to_f
+
+    # Log entries refer to a particular resource
+    # Mock the resource to refer to the test project being used
+    # Also append the current time to the log message for asserting existence
+    allow(@logging).to receive(:write_entries).and_wrap_original do |m, entry|
+      # Verify entry payload and resource from sample
+      expect(entry.payload).to eq "Log message"
+      expect(entry.resource.type).to eq "gae_app"
+      expect(entry.resource.labels[:module_id]).to eq "default"
+      expect(entry.resource.labels[:version_id]).to eq "20160101t163030"
+
+      # Update entry to log to test resource
+      entry.payload += " - current time #{current_time}"
+      entry.resource.type = "project"
+      entry.resource.labels.clear
+      entry.resource.labels[:project_id] = project_id
+
+      m.call(entry)
+    end
+
+    entries = @logging.entries(
+      filter: %{logName = "projects/#{project_id}/logs/my_application_log"},
+      order: "timestamp desc"
+    )
+    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    expect(entry).to be nil
+
+    write_log_entry
+
+    # Wait for entry to be queryable
+    sleep 3
+
+    entries = @logging.entries(
+      filter: %{logName = "projects/#{project_id}/logs/my_application_log"},
+      order: "timestamp desc"
+    )
+    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    expect(entry).not_to be nil
+    expect(entry.payload).to eq "Log message - current time #{current_time}"
+    expect(entry.severity).to eq :NOTICE
+    expect(entry.log_name).to eq(
+      "projects/#{project_id}/logs/my_application_log"
+    )
+  end
+
+  it "can delete log"
+
+  it "can write log entry using Ruby Logger" do
+    project_id = ENV["GCLOUD_PROJECT"]
+    current_time = Time.now.to_f
+
+    entries = @logging.entries(
+      filter: %{logName = "projects/#{project_id}/logs/my_application_log"},
+      order: "timestamp desc"
+    )
+    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    expect(entry).to be nil
+
+    # Hooked up to real test project
+    logger = @logging.logger(
+      "my_application_log",
+      @logging.resource("project", project_id: ENV["GCLOUD_PROJECT"])
+    )
+
+    # Log entries refer to a particular resource
+    # Mock the resource to refer to the test project being used
+    # Also append the current time to the log message for asserting existence
+    allow(@logging).to receive(:logger) do |name, resource|
+      # Verify entry payload and resource from sample
+      expect(name).to eq "my_application_log"
+      expect(resource.type).to eq "gae_app"
+      expect(resource.labels[:module_id]).to eq "default"
+      expect(resource.labels[:version_id]).to eq "20160101t163030"
+      logger
+    end
+
+    # Append unique string to logged message for assertion
+    allow(logger).to receive(:info).and_wrap_original do |m, message|
+      message += " - current time #{current_time}"
+      m.call message
+    end
+
+    write_log_entry_using_ruby_logger  
+
+    # Wait for entry to be queryable
+    sleep 5
+
+    entries = @logging.entries(
+      filter: %{logName = "projects/#{project_id}/logs/my_application_log"},
+      order: "timestamp desc"
+    )
+    entry = entries.detect {|e| e.payload.include? "time #{current_time}" }
+    expect(entry).not_to be nil
+    expect(entry.payload).to eq "Log message - current time #{current_time}"
+    expect(entry.severity).to eq :INFO
+    expect(entry.log_name).to eq(
+      "projects/#{project_id}/logs/my_application_log"
+    )
+  end
 end