haveapi-go-client 0.26.5 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88b50c54ba792fb0420bbd433c4215369b81c41cc125d705a28ea727a01baa15
-  data.tar.gz: e7de963b436ffbd6b9d8a4f08547c217cdf154e40aa6e0ba422247e77159ebfe
+  metadata.gz: bb661e4d9dd5ab5b29d5d3b63af4b37a486848e0623a6e34ac41f53f0a0feebe
+  data.tar.gz: 485e7d815e181bf209d541a0eb63c305acd79440cba6144812263b25108369de
 SHA512:
-  metadata.gz: 2c7000a73203516df6beb46ee9399d35f3e485a946788b99b50cb4dd28f2d6933109774468f5be86f1d042452978a2b878ab840fc4f7d84bd59be30cfd4a31c0
-  data.tar.gz: ab94917cb2c4cc52a8d0a7b15d63701e80288fb6884a00d2d931a9bc004148e7615dc75c1388d995ea71f22c46d0ca045d698e64f357fead19a65363b8cc95f2
+  metadata.gz: c6ff55c1c5d592a79c5052df6ee2ea9311e0039b7d37068d9048d592ee2fe0b63913c9dca088387abf57a1937b015a75c4bf3c664a20aac9875f62e2d88236d3
+  data.tar.gz: 06014c3863378caf51e02c6b6be0d919f740d6659974c185915ec89a8b0a4bd07434e625481599704ead36f3565e718fd0817462d6400462a0dcda01abd1097d

data/Gemfile

@@ -7,3 +7,7 @@ group :development do
   gem 'bundler'
   gem 'rake'
 end
+
+group :test do
+  gem 'rspec'
+end

data/haveapi-go-client.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'haveapi-client', '~> 0.26.5'
+  spec.add_dependency 'haveapi-client', '~> 0.27.0'
 end

data/lib/haveapi/go_client/cli.rb

@@ -22,6 +22,14 @@ module HaveAPI::GoClient
         opts.on('--package PKG', 'Name of the generated Go package') do |v|
           options[:package] = v
         end
+
+        opts.on('--basic-user USER', 'Basic auth username for API description') do |v|
+          options[:basic_user] = v
+        end
+
+        opts.on('--basic-password PASSWORD', 'Basic auth password for API description') do |v|
+          options[:basic_password] = v
+        end
       end
 
       parser.parse!

data/lib/haveapi/go_client/generator.rb

@@ -27,6 +27,9 @@ module HaveAPI::GoClient
       @package = opts[:package]
 
       conn = HaveAPI::Client::Communicator.new(url)
+      if opts[:basic_user] && opts[:basic_password]
+        conn.authenticate(:basic, user: opts[:basic_user], password: opts[:basic_password])
+      end
       @api = ApiVersion.new(conn.describe_api(opts[:version]))
     end
 

data/lib/haveapi/go_client/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module GoClient
-    VERSION = '0.26.5'.freeze
+    VERSION = '0.27.0'.freeze
   end
 end

data/spec/integration/generator_spec.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe HaveAPI::GoClient::Generator do
+  let(:base_url) { TEST_SERVER.base_url }
+  let(:root) { File.expand_path('../../../..', __dir__) }
+  let(:cwd) { File.join(root, 'clients', 'go') }
+
+  it 'generates a client that compiles and can call the API' do
+    Dir.mktmpdir('haveapi-go-client-') do |dir|
+      cmd = [
+        'bundle', 'exec', 'ruby', 'bin/haveapi-go-client',
+        base_url, dir,
+        '--module', 'example.com/haveapi-test',
+        '--package', 'client',
+        '--basic-user', 'user',
+        '--basic-password', 'pass'
+      ]
+
+      stdout, stderr, status = Open3.capture3(*cmd, chdir: cwd)
+      expect(status).to be_success, "generator failed: #{stdout}\n#{stderr}"
+
+      File.write(File.join(dir, 'client', 'client_integration_test.go'), <<~GO)
+        package client
+
+        import "testing"
+
+        func TestProjectList(t *testing.T) {
+          c := New("#{base_url}")
+          c.SetBasicAuthentication("user", "pass")
+
+          resp, err := c.Project.List.Prepare().Call()
+          if err != nil {
+            t.Fatalf("list failed: %v", err)
+          }
+
+          if !resp.Status {
+            t.Fatalf("request failed: %s", resp.Message)
+          }
+
+          if len(resp.Output) < 2 {
+            t.Fatalf("expected at least 2 projects, got %d", len(resp.Output))
+          }
+        }
+      GO
+
+      File.write(File.join(dir, 'client', 'client_validation_test.go'), <<~GO)
+        package client
+
+        import (
+          "math"
+          "testing"
+        )
+
+        func newValidationClient() *Client {
+          c := New("#{base_url}")
+          c.SetBasicAuthentication("user", "pass")
+          return c
+        }
+
+        func TestEchoRejectsNaNFloat(t *testing.T) {
+          c := newValidationClient()
+          req := c.Test.Echo.Prepare()
+          in := req.NewInput()
+          in.SetI(1)
+          in.SetF(math.NaN())
+          in.SetB(true)
+          in.SetDt("2020-01-01T00:00:00Z")
+          in.SetS("x")
+          in.SetT("y")
+
+          _, err := req.Call()
+          if err == nil {
+            t.Fatalf("expected validation error, got nil")
+          }
+
+          verr, ok := err.(*ValidationError)
+          if !ok {
+            t.Fatalf("expected ValidationError, got %T: %v", err, err)
+          }
+
+          if verr.Errors["f"] == nil {
+            t.Fatalf("expected float error, got %#v", verr.Errors)
+          }
+        }
+
+        func TestEchoRejectsInvalidDatetime(t *testing.T) {
+          c := newValidationClient()
+          req := c.Test.Echo.Prepare()
+          in := req.NewInput()
+          in.SetI(1)
+          in.SetF(1.0)
+          in.SetB(true)
+          in.SetDt("not-a-date")
+          in.SetS("x")
+          in.SetT("y")
+
+          _, err := req.Call()
+          if err == nil {
+            t.Fatalf("expected validation error, got nil")
+          }
+
+          verr, ok := err.(*ValidationError)
+          if !ok {
+            t.Fatalf("expected ValidationError, got %T: %v", err, err)
+          }
+
+          if verr.Errors["dt"] == nil {
+            t.Fatalf("expected datetime error, got %#v", verr.Errors)
+          }
+        }
+
+        func TestEchoResourceRejectsNegativeID(t *testing.T) {
+          c := newValidationClient()
+          req := c.Test.EchoResource.Prepare()
+          in := req.NewInput()
+          in.SetProject(-1)
+
+          _, err := req.Call()
+          if err == nil {
+            t.Fatalf("expected validation error, got nil")
+          }
+
+          verr, ok := err.(*ValidationError)
+          if !ok {
+            t.Fatalf("expected ValidationError, got %T: %v", err, err)
+          }
+
+          if verr.Errors["project"] == nil {
+            t.Fatalf("expected resource error, got %#v", verr.Errors)
+          }
+        }
+
+        func TestEchoAcceptsValidInput(t *testing.T) {
+          c := newValidationClient()
+          req := c.Test.Echo.Prepare()
+          in := req.NewInput()
+          in.SetI(123)
+          in.SetF(1.5)
+          in.SetB(true)
+          in.SetDt("2020-01-01")
+          in.SetS("hello")
+          in.SetT("world")
+
+          resp, err := req.Call()
+          if err != nil {
+            t.Fatalf("echo failed: %v", err)
+          }
+
+          if !resp.Status {
+            t.Fatalf("request failed: %s", resp.Message)
+          }
+        }
+      GO
+
+      go_out, go_err, go_status = Open3.capture3('go', 'test', './...', chdir: dir)
+      expect(go_status).to be_success, "go test failed: #{go_out}\n#{go_err}"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'open3'
+require 'tmpdir'
+require 'haveapi/go_client'
+
+require_relative 'support/test_server'
+
+TEST_SERVER = ClientTestServer.new
+
+RSpec.configure do |config|
+  config.order = :random
+
+  config.before(:suite) do
+    TEST_SERVER.start
+  end
+
+  config.after(:suite) do
+    TEST_SERVER.stop!
+  end
+
+  config.before do
+    TEST_SERVER.reset!
+  end
+end

data/spec/support/test_server.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'net/http'
+require 'timeout'
+require 'uri'
+
+class ClientTestServer
+  READY_PREFIX = 'HAVEAPI_TEST_SERVER_READY'
+
+  attr_reader :base_url
+
+  def initialize
+    @root = File.expand_path('../../../..', __dir__)
+    @server_script = File.join(@root, 'servers', 'ruby', 'test_support', 'client_test_server.rb')
+    @gemfile = File.join(@root, 'servers', 'ruby', 'Gemfile')
+    @cwd = File.join(@root, 'clients', 'go')
+  end
+
+  def start
+    return if @wait_thr
+
+    env = { 'BUNDLE_GEMFILE' => @gemfile }
+    cmd = ['bundle', 'exec', 'ruby', @server_script, '--port', '0']
+    @stdin, @stdout, @wait_thr = Open3.popen2e(env, *cmd, chdir: @cwd)
+
+    read_ready!
+    wait_for_health!
+  end
+
+  def reset!
+    ensure_started!
+
+    uri = URI.join(@base_url, '/__reset')
+    req = Net::HTTP::Post.new(uri)
+    req['Content-Type'] = 'application/json'
+    res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+
+    return if res.is_a?(Net::HTTPSuccess)
+
+    raise "reset failed: #{res.code} #{res.body}"
+  end
+
+  def stop!
+    return unless @wait_thr
+
+    Process.kill('TERM', @wait_thr.pid)
+    @wait_thr.value
+  rescue Errno::ESRCH
+    nil
+  ensure
+    @stdin&.close
+    @stdout&.close
+    @wait_thr = nil
+  end
+
+  private
+
+  def ensure_started!
+    start unless @wait_thr
+  end
+
+  def read_ready!
+    Timeout.timeout(10) do
+      while (line = @stdout.gets)
+        next unless line.include?(READY_PREFIX)
+
+        @base_url = line.split.last&.strip
+        break
+      end
+    end
+
+    raise 'server did not start' unless @base_url
+  rescue Timeout::Error
+    raise 'server did not start in time'
+  end
+
+  def wait_for_health!
+    Timeout.timeout(5) do
+      loop do
+        begin
+          uri = URI.join(@base_url, '/__health')
+          res = Net::HTTP.get_response(uri)
+          return if res.is_a?(Net::HTTPSuccess)
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH, IOError
+          # retry
+        end
+
+        sleep 0.05
+      end
+    end
+  rescue Timeout::Error
+    raise 'server did not become healthy in time'
+  end
+end

data/template/action.go.erb

@@ -365,8 +365,77 @@ func (inv *<%= action.go_invocation_type %>) IsMetaParameterNil(param string) bo
 }
 <% end -%>
 
+func (inv *<%= action.go_invocation_type %>) validate() error {
+	verr := NewValidationError()
+<% if action.has_input? -%>
+	if inv.Input != nil {
+<% action.input.parameters.each do |p| -%>
+<% if %w(Float Datetime Resource).include?(p.type) -%>
+		if inv.IsParameterSelected("<%= p.go_name %>") {
+			if !inv.IsParameterNil("<%= p.go_name %>") {
+<% if p.type == 'Float' -%>
+				if !isFiniteFloat64(inv.Input.<%= p.go_name %>) {
+					verr.Add("<%= p.name %>", "not a valid float")
+				}
+<% elsif p.type == 'Datetime' -%>
+				normalized, ok := normalizeAndCheckDatetimeString(inv.Input.<%= p.go_name %>)
+				if !ok {
+					verr.Add("<%= p.name %>", "not a valid datetime")
+				} else {
+					inv.Input.<%= p.go_name %> = normalized
+				}
+<% elsif p.type == 'Resource' -%>
+				if inv.Input.<%= p.go_name %> < 0 {
+					verr.Add("<%= p.name %>", "not a valid resource id")
+				}
+<% end -%>
+			}
+		}
+<% end -%>
+<% end -%>
+	}
+<% end -%>
+<% if action.metadata.has_global_input? -%>
+	if inv.MetaInput != nil {
+<% action.metadata.global.input.parameters.each do |p| -%>
+<% if %w(Float Datetime Resource).include?(p.type) -%>
+		if inv.IsMetaParameterSelected("<%= p.go_name %>") {
+			if !inv.IsMetaParameterNil("<%= p.go_name %>") {
+<% if p.type == 'Float' -%>
+				if !isFiniteFloat64(inv.MetaInput.<%= p.go_name %>) {
+					verr.Add("<%= p.name %>", "not a valid float")
+				}
+<% elsif p.type == 'Datetime' -%>
+				normalized, ok := normalizeAndCheckDatetimeString(inv.MetaInput.<%= p.go_name %>)
+				if !ok {
+					verr.Add("<%= p.name %>", "not a valid datetime")
+				} else {
+					inv.MetaInput.<%= p.go_name %> = normalized
+				}
+<% elsif p.type == 'Resource' -%>
+				if inv.MetaInput.<%= p.go_name %> < 0 {
+					verr.Add("<%= p.name %>", "not a valid resource id")
+				}
+<% end -%>
+			}
+		}
+<% end -%>
+<% end -%>
+	}
+<% end -%>
+
+	if verr.Empty() {
+		return nil
+	}
+
+	return verr
+}
+
 // Call() invokes the action and returns a response from the API server
 func (inv *<%= action.go_invocation_type %>) Call() (*<%= action.go_response_type %>, error) {
+	if err := inv.validate(); err != nil {
+		return nil, err
+	}
 <% if action.http_method == 'GET' -%>
 	return inv.callAsQuery()
 <% else -%>

data/template/types.go.erb

@@ -1,7 +1,11 @@
 package <%= package %>
 
 import (
+	"math"
+	"sort"
 	"strconv"
+	"strings"
+	"time"
 )
 
 type ProgressCallbackReturn int
@@ -20,6 +24,82 @@ type BlockingOperationWatcher interface {
 	WatchOperation(timeout float64, updateIn float64, callback OperationProgressCallback) (*ActionActionStatePollResponse, error)
 }
 
+type ValidationError struct {
+	Errors map[string][]string
+}
+
+func NewValidationError() *ValidationError {
+	return &ValidationError{
+		Errors: make(map[string][]string),
+	}
+}
+
+func (e *ValidationError) Add(param string, msg string) {
+	if e.Errors == nil {
+		e.Errors = make(map[string][]string)
+	}
+
+	e.Errors[param] = append(e.Errors[param], msg)
+}
+
+func (e *ValidationError) Empty() bool {
+	if e == nil {
+		return true
+	}
+
+	return len(e.Errors) == 0
+}
+
+func (e *ValidationError) Error() string {
+	if e == nil || len(e.Errors) == 0 {
+		return "validation failed"
+	}
+
+	keys := make([]string, 0, len(e.Errors))
+	for key := range e.Errors {
+		keys = append(keys, key)
+	}
+
+	sort.Strings(keys)
+
+	parts := make([]string, 0, len(keys))
+	for _, key := range keys {
+		messages := e.Errors[key]
+		if len(messages) == 0 {
+			parts = append(parts, key)
+		} else {
+			parts = append(parts, key+": "+strings.Join(messages, ", "))
+		}
+	}
+
+	return "validation failed: " + strings.Join(parts, "; ")
+}
+
+func isFiniteFloat64(v float64) bool {
+	return !math.IsNaN(v) && !math.IsInf(v, 0)
+}
+
+func normalizeAndCheckDatetimeString(v string) (string, bool) {
+	trimmed := strings.TrimSpace(v)
+	if trimmed == "" {
+		return trimmed, false
+	}
+
+	if _, err := time.Parse("2006-01-02", trimmed); err == nil {
+		return trimmed, true
+	}
+
+	if _, err := time.Parse(time.RFC3339, trimmed); err == nil {
+		return trimmed, true
+	}
+
+	if _, err := time.Parse(time.RFC3339Nano, trimmed); err == nil {
+		return trimmed, true
+	}
+
+	return trimmed, false
+}
+
 func convertInt64ToString(v int64) string {
 	return strconv.FormatInt(v, 10)
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-go-client
 version: !ruby/object:Gem::Version
-  version: 0.26.5
+  version: 0.27.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.5
+        version: 0.27.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.26.5
+        version: 0.27.0
 description: Go client generator
 email:
 - jakub.skokan@vpsfree.cz
@@ -61,6 +61,9 @@ files:
 - lib/haveapi/go_client/utils.rb
 - lib/haveapi/go_client/version.rb
 - shell.nix
+- spec/integration/generator_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_server.rb
 - template/action.go.erb
 - template/authentication.go.erb
 - template/authentication/basic.go.erb