google-cloud-debugger 0.24.0

data/lib/google/cloud/debugger/v2/doc/google/devtools/source/v1/source_context.rb

@@ -0,0 +1,161 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# 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.
+
+module Google
+  module Devtools
+    module Source
+      module V1
+        # A SourceContext is a reference to a tree of files. A SourceContext together
+        # with a path point to a unique revision of a single file or directory.
+        # @!attribute [rw] cloud_repo
+        #   @return [Google::Devtools::Source::V1::CloudRepoSourceContext]
+        #     A SourceContext referring to a revision in a cloud repo.
+        # @!attribute [rw] cloud_workspace
+        #   @return [Google::Devtools::Source::V1::CloudWorkspaceSourceContext]
+        #     A SourceContext referring to a snapshot in a cloud workspace.
+        # @!attribute [rw] gerrit
+        #   @return [Google::Devtools::Source::V1::GerritSourceContext]
+        #     A SourceContext referring to a Gerrit project.
+        # @!attribute [rw] git
+        #   @return [Google::Devtools::Source::V1::GitSourceContext]
+        #     A SourceContext referring to any third party Git repo (e.g. GitHub).
+        class SourceContext; end
+
+        # An ExtendedSourceContext is a SourceContext combined with additional
+        # details describing the context.
+        # @!attribute [rw] context
+        #   @return [Google::Devtools::Source::V1::SourceContext]
+        #     Any source context.
+        # @!attribute [rw] labels
+        #   @return [Hash{String => String}]
+        #     Labels with user defined metadata.
+        class ExtendedSourceContext; end
+
+        # An alias to a repo revision.
+        # @!attribute [rw] kind
+        #   @return [Google::Devtools::Source::V1::AliasContext::Kind]
+        #     The alias kind.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The alias name.
+        class AliasContext
+          # The type of an Alias.
+          module Kind
+            # Do not use.
+            ANY = 0
+
+            # Git tag
+            FIXED = 1
+
+            # Git branch
+            MOVABLE = 2
+
+            # OTHER is used to specify non-standard aliases, those not of the kinds
+            # above. For example, if a Git repo has a ref named "refs/foo/bar", it
+            # is considered to be of kind OTHER.
+            OTHER = 4
+          end
+        end
+
+        # A CloudRepoSourceContext denotes a particular revision in a cloud
+        # repo (a repo hosted by the Google Cloud Platform).
+        # @!attribute [rw] repo_id
+        #   @return [Google::Devtools::Source::V1::RepoId]
+        #     The ID of the repo.
+        # @!attribute [rw] revision_id
+        #   @return [String]
+        #     A revision ID.
+        # @!attribute [rw] alias_name
+        #   @return [String]
+        #     The name of an alias (branch, tag, etc.).
+        # @!attribute [rw] alias_context
+        #   @return [Google::Devtools::Source::V1::AliasContext]
+        #     An alias, which may be a branch or tag.
+        class CloudRepoSourceContext; end
+
+        # A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.
+        # @!attribute [rw] workspace_id
+        #   @return [Google::Devtools::Source::V1::CloudWorkspaceId]
+        #     The ID of the workspace.
+        # @!attribute [rw] snapshot_id
+        #   @return [String]
+        #     The ID of the snapshot.
+        #     An empty snapshot_id refers to the most recent snapshot.
+        class CloudWorkspaceSourceContext; end
+
+        # A SourceContext referring to a Gerrit project.
+        # @!attribute [rw] host_uri
+        #   @return [String]
+        #     The URI of a running Gerrit instance.
+        # @!attribute [rw] gerrit_project
+        #   @return [String]
+        #     The full project name within the host. Projects may be nested, so
+        #     "project/subproject" is a valid project name.
+        #     The "repo name" is hostURI/project.
+        # @!attribute [rw] revision_id
+        #   @return [String]
+        #     A revision (commit) ID.
+        # @!attribute [rw] alias_name
+        #   @return [String]
+        #     The name of an alias (branch, tag, etc.).
+        # @!attribute [rw] alias_context
+        #   @return [Google::Devtools::Source::V1::AliasContext]
+        #     An alias, which may be a branch or tag.
+        class GerritSourceContext; end
+
+        # A GitSourceContext denotes a particular revision in a third party Git
+        # repository (e.g. GitHub).
+        # @!attribute [rw] url
+        #   @return [String]
+        #     Git repository URL.
+        # @!attribute [rw] revision_id
+        #   @return [String]
+        #     Git commit hash.
+        #     required.
+        class GitSourceContext; end
+
+        # A unique identifier for a cloud repo.
+        # @!attribute [rw] project_repo_id
+        #   @return [Google::Devtools::Source::V1::ProjectRepoId]
+        #     A combination of a project ID and a repo name.
+        # @!attribute [rw] uid
+        #   @return [String]
+        #     A server-assigned, globally unique identifier.
+        class RepoId; end
+
+        # Selects a repo using a Google Cloud Platform project ID
+        # (e.g. winged-cargo-31) and a repo name within that project.
+        # @!attribute [rw] project_id
+        #   @return [String]
+        #     The ID of the project.
+        # @!attribute [rw] repo_name
+        #   @return [String]
+        #     The name of the repo. Leave empty for the default repo.
+        class ProjectRepoId; end
+
+        # A CloudWorkspaceId is a unique identifier for a cloud workspace.
+        # A cloud workspace is a place associated with a repo where modified files
+        # can be stored before they are committed.
+        # @!attribute [rw] repo_id
+        #   @return [Google::Devtools::Source::V1::RepoId]
+        #     The ID of the repo containing the workspace.
+        # @!attribute [rw] name
+        #   @return [String]
+        #     The unique name of the workspace within the repo.  This is the name
+        #     chosen by the client in the Source API's CreateWorkspace method.
+        class CloudWorkspaceId; end
+      end
+    end
+  end
+end

data/lib/google/cloud/debugger/v2/doc/google/protobuf/timestamp.rb

@@ -0,0 +1,81 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# 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.
+
+module Google
+  module Protobuf
+    # A Timestamp represents a point in time independent of any time zone
+    # or calendar, represented as seconds and fractions of seconds at
+    # nanosecond resolution in UTC Epoch time. It is encoded using the
+    # Proleptic Gregorian Calendar which extends the Gregorian calendar
+    # backwards to year one. It is encoded assuming all minutes are 60
+    # seconds long, i.e. leap seconds are "smeared" so that no leap second
+    # table is needed for interpretation. Range is from
+    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
+    # By restricting to that range, we ensure that we can convert to
+    # and from  RFC 3339 date strings.
+    # See {https://www.ietf.org/rfc/rfc3339.txt}[https://www.ietf.org/rfc/rfc3339.txt].
+    #
+    # Example 1: Compute Timestamp from POSIX +time()+.
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(time(NULL));
+    #     timestamp.set_nanos(0);
+    #
+    # Example 2: Compute Timestamp from POSIX +gettimeofday()+.
+    #
+    #     struct timeval tv;
+    #     gettimeofday(&tv, NULL);
+    #
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds(tv.tv_sec);
+    #     timestamp.set_nanos(tv.tv_usec * 1000);
+    #
+    # Example 3: Compute Timestamp from Win32 +GetSystemTimeAsFileTime()+.
+    #
+    #     FILETIME ft;
+    #     GetSystemTimeAsFileTime(&ft);
+    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
+    #
+    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
+    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
+    #     Timestamp timestamp;
+    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
+    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
+    #
+    # Example 4: Compute Timestamp from Java +System.currentTimeMillis()+.
+    #
+    #     long millis = System.currentTimeMillis();
+    #
+    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
+    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
+    #
+    #
+    # Example 5: Compute Timestamp from current time in Python.
+    #
+    #     timestamp = Timestamp()
+    #     timestamp.GetCurrentTime()
+    # @!attribute [rw] seconds
+    #   @return [Integer]
+    #     Represents seconds of UTC time since Unix epoch
+    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
+    #     9999-12-31T23:59:59Z inclusive.
+    # @!attribute [rw] nanos
+    #   @return [Integer]
+    #     Non-negative fractions of a second at nanosecond resolution. Negative
+    #     second values with fractions must still have non-negative nanos values
+    #     that count forward in time. Must be from 0 to 999,999,999
+    #     inclusive.
+    class Timestamp; end
+  end
+end

data/lib/google/cloud/debugger/version.rb

@@ -0,0 +1,22 @@
+# Copyright 2017 Google Inc. All rights reserved.
+#
+# 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.
+
+
+module Google
+  module Cloud
+    module Debugger
+      VERSION = "0.24.0"
+    end
+  end
+end

data/lib/google/devtools/clouddebugger/v2/controller_pb.rb

@@ -0,0 +1,47 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/devtools/clouddebugger/v2/controller.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/devtools/clouddebugger/v2/data_pb'
+require 'google/protobuf/empty_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.devtools.clouddebugger.v2.RegisterDebuggeeRequest" do
+    optional :debuggee, :message, 1, "google.devtools.clouddebugger.v2.Debuggee"
+  end
+  add_message "google.devtools.clouddebugger.v2.RegisterDebuggeeResponse" do
+    optional :debuggee, :message, 1, "google.devtools.clouddebugger.v2.Debuggee"
+  end
+  add_message "google.devtools.clouddebugger.v2.ListActiveBreakpointsRequest" do
+    optional :debuggee_id, :string, 1
+    optional :wait_token, :string, 2
+    optional :success_on_timeout, :bool, 3
+  end
+  add_message "google.devtools.clouddebugger.v2.ListActiveBreakpointsResponse" do
+    repeated :breakpoints, :message, 1, "google.devtools.clouddebugger.v2.Breakpoint"
+    optional :next_wait_token, :string, 2
+    optional :wait_expired, :bool, 3
+  end
+  add_message "google.devtools.clouddebugger.v2.UpdateActiveBreakpointRequest" do
+    optional :debuggee_id, :string, 1
+    optional :breakpoint, :message, 2, "google.devtools.clouddebugger.v2.Breakpoint"
+  end
+  add_message "google.devtools.clouddebugger.v2.UpdateActiveBreakpointResponse" do
+  end
+end
+
+module Google
+  module Devtools
+    module Clouddebugger
+      module V2
+        RegisterDebuggeeRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.RegisterDebuggeeRequest").msgclass
+        RegisterDebuggeeResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.RegisterDebuggeeResponse").msgclass
+        ListActiveBreakpointsRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.ListActiveBreakpointsRequest").msgclass
+        ListActiveBreakpointsResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.ListActiveBreakpointsResponse").msgclass
+        UpdateActiveBreakpointRequest = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.UpdateActiveBreakpointRequest").msgclass
+        UpdateActiveBreakpointResponse = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.UpdateActiveBreakpointResponse").msgclass
+      end
+    end
+  end
+end

data/lib/google/devtools/clouddebugger/v2/controller_services_pb.rb

@@ -0,0 +1,97 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# Source: google/devtools/clouddebugger/v2/controller.proto for package 'google.devtools.clouddebugger.v2'
+# Original file comments:
+# Copyright 2017 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 'grpc'
+require 'google/devtools/clouddebugger/v2/controller_pb'
+
+module Google
+  module Devtools
+    module Clouddebugger
+      module V2
+        module Controller2
+          # The Controller service provides the API for orchestrating a collection of
+          # debugger agents to perform debugging tasks. These agents are each attached
+          # to a process of an application which may include one or more replicas.
+          #
+          # The debugger agents register with the Controller to identify the application
+          # being debugged, the Debuggee. All agents that register with the same data,
+          # represent the same Debuggee, and are assigned the same `debuggee_id`.
+          #
+          # The debugger agents call the Controller to retrieve  the list of active
+          # Breakpoints. Agents with the same `debuggee_id` get the same breakpoints
+          # list. An agent that can fulfill the breakpoint request updates the
+          # Controller with the breakpoint result. The controller selects the first
+          # result received and discards the rest of the results.
+          # Agents that poll again for active breakpoints will no longer have
+          # the completed breakpoint in the list and should remove that breakpoint from
+          # their attached process.
+          #
+          # The Controller service does not provide a way to retrieve the results of
+          # a completed breakpoint. This functionality is available using the Debugger
+          # service.
+          class Service
+
+            include GRPC::GenericService
+
+            self.marshal_class_method = :encode
+            self.unmarshal_class_method = :decode
+            self.service_name = 'google.devtools.clouddebugger.v2.Controller2'
+
+            # Registers the debuggee with the controller service.
+            #
+            # All agents attached to the same application should call this method with
+            # the same request content to get back the same stable `debuggee_id`. Agents
+            # should call this method again whenever `google.rpc.Code.NOT_FOUND` is
+            # returned from any controller method.
+            #
+            # This allows the controller service to disable the agent or recover from any
+            # data loss. If the debuggee is disabled by the server, the response will
+            # have `is_disabled` set to `true`.
+            rpc :RegisterDebuggee, RegisterDebuggeeRequest, RegisterDebuggeeResponse
+            # Returns the list of all active breakpoints for the debuggee.
+            #
+            # The breakpoint specification (location, condition, and expression
+            # fields) is semantically immutable, although the field values may
+            # change. For example, an agent may update the location line number
+            # to reflect the actual line where the breakpoint was set, but this
+            # doesn't change the breakpoint semantics.
+            #
+            # This means that an agent does not need to check if a breakpoint has changed
+            # when it encounters the same breakpoint on a successive call.
+            # Moreover, an agent should remember the breakpoints that are completed
+            # until the controller removes them from the active list to avoid
+            # setting those breakpoints again.
+            rpc :ListActiveBreakpoints, ListActiveBreakpointsRequest, ListActiveBreakpointsResponse
+            # Updates the breakpoint state or mutable fields.
+            # The entire Breakpoint message must be sent back to the controller
+            # service.
+            #
+            # Updates to active breakpoint fields are only allowed if the new value
+            # does not change the breakpoint specification. Updates to the `location`,
+            # `condition` and `expression` fields should not alter the breakpoint
+            # semantics. These may only make changes such as canonicalizing a value
+            # or snapping the location to the correct line of code.
+            rpc :UpdateActiveBreakpoint, UpdateActiveBreakpointRequest, UpdateActiveBreakpointResponse
+          end
+
+          Stub = Service.rpc_stub_class
+        end
+      end
+    end
+  end
+end

data/lib/google/devtools/clouddebugger/v2/data_pb.rb

@@ -0,0 +1,105 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/devtools/clouddebugger/v2/data.proto
+
+require 'google/protobuf'
+
+require 'google/api/annotations_pb'
+require 'google/devtools/source/v1/source_context_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/protobuf/wrappers_pb'
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_message "google.devtools.clouddebugger.v2.FormatMessage" do
+    optional :format, :string, 1
+    repeated :parameters, :string, 2
+  end
+  add_message "google.devtools.clouddebugger.v2.StatusMessage" do
+    optional :is_error, :bool, 1
+    optional :refers_to, :enum, 2, "google.devtools.clouddebugger.v2.StatusMessage.Reference"
+    optional :description, :message, 3, "google.devtools.clouddebugger.v2.FormatMessage"
+  end
+  add_enum "google.devtools.clouddebugger.v2.StatusMessage.Reference" do
+    value :UNSPECIFIED, 0
+    value :BREAKPOINT_SOURCE_LOCATION, 3
+    value :BREAKPOINT_CONDITION, 4
+    value :BREAKPOINT_EXPRESSION, 7
+    value :VARIABLE_NAME, 5
+    value :VARIABLE_VALUE, 6
+  end
+  add_message "google.devtools.clouddebugger.v2.SourceLocation" do
+    optional :path, :string, 1
+    optional :line, :int32, 2
+  end
+  add_message "google.devtools.clouddebugger.v2.Variable" do
+    optional :name, :string, 1
+    optional :value, :string, 2
+    optional :type, :string, 6
+    repeated :members, :message, 3, "google.devtools.clouddebugger.v2.Variable"
+    optional :var_table_index, :message, 4, "google.protobuf.Int32Value"
+    optional :status, :message, 5, "google.devtools.clouddebugger.v2.StatusMessage"
+  end
+  add_message "google.devtools.clouddebugger.v2.StackFrame" do
+    optional :function, :string, 1
+    optional :location, :message, 2, "google.devtools.clouddebugger.v2.SourceLocation"
+    repeated :arguments, :message, 3, "google.devtools.clouddebugger.v2.Variable"
+    repeated :locals, :message, 4, "google.devtools.clouddebugger.v2.Variable"
+  end
+  add_message "google.devtools.clouddebugger.v2.Breakpoint" do
+    optional :id, :string, 1
+    optional :action, :enum, 13, "google.devtools.clouddebugger.v2.Breakpoint.Action"
+    optional :location, :message, 2, "google.devtools.clouddebugger.v2.SourceLocation"
+    optional :condition, :string, 3
+    repeated :expressions, :string, 4
+    optional :log_message_format, :string, 14
+    optional :log_level, :enum, 15, "google.devtools.clouddebugger.v2.Breakpoint.LogLevel"
+    optional :is_final_state, :bool, 5
+    optional :create_time, :message, 11, "google.protobuf.Timestamp"
+    optional :final_time, :message, 12, "google.protobuf.Timestamp"
+    optional :user_email, :string, 16
+    optional :status, :message, 10, "google.devtools.clouddebugger.v2.StatusMessage"
+    repeated :stack_frames, :message, 7, "google.devtools.clouddebugger.v2.StackFrame"
+    repeated :evaluated_expressions, :message, 8, "google.devtools.clouddebugger.v2.Variable"
+    repeated :variable_table, :message, 9, "google.devtools.clouddebugger.v2.Variable"
+    map :labels, :string, :string, 17
+  end
+  add_enum "google.devtools.clouddebugger.v2.Breakpoint.Action" do
+    value :CAPTURE, 0
+    value :LOG, 1
+  end
+  add_enum "google.devtools.clouddebugger.v2.Breakpoint.LogLevel" do
+    value :INFO, 0
+    value :WARNING, 1
+    value :ERROR, 2
+  end
+  add_message "google.devtools.clouddebugger.v2.Debuggee" do
+    optional :id, :string, 1
+    optional :project, :string, 2
+    optional :uniquifier, :string, 3
+    optional :description, :string, 4
+    optional :is_inactive, :bool, 5
+    optional :agent_version, :string, 6
+    optional :is_disabled, :bool, 7
+    optional :status, :message, 8, "google.devtools.clouddebugger.v2.StatusMessage"
+    repeated :source_contexts, :message, 9, "google.devtools.source.v1.SourceContext"
+    repeated :ext_source_contexts, :message, 13, "google.devtools.source.v1.ExtendedSourceContext"
+    map :labels, :string, :string, 11
+  end
+end
+
+module Google
+  module Devtools
+    module Clouddebugger
+      module V2
+        FormatMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.FormatMessage").msgclass
+        StatusMessage = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.StatusMessage").msgclass
+        StatusMessage::Reference = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.StatusMessage.Reference").enummodule
+        SourceLocation = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.SourceLocation").msgclass
+        Variable = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.Variable").msgclass
+        StackFrame = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.StackFrame").msgclass
+        Breakpoint = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.Breakpoint").msgclass
+        Breakpoint::Action = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.Breakpoint.Action").enummodule
+        Breakpoint::LogLevel = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.Breakpoint.LogLevel").enummodule
+        Debuggee = Google::Protobuf::DescriptorPool.generated_pool.lookup("google.devtools.clouddebugger.v2.Debuggee").msgclass
+      end
+    end
+  end
+end