minke-generator-go 0.1.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e44687462591b411096667b256f5a6a967e180bb
-  data.tar.gz: 626f70ea6aea969c00d05843eb4046544c764253
+  metadata.gz: 919e1b5d93dbcbc2fa3add6dc68e6f44376982fa
+  data.tar.gz: ecdf27932dca828d8f6b296a5e61450815c5ea93
 SHA512:
-  metadata.gz: ac815ffe9b0ceaa97e06c66747e220b9b1eb7763f6286bbbbae94cb25d41967f87948956a78c0b7b7825987c184f7c04f62dff27ab6deba36b5fcbfa8235b004
-  data.tar.gz: fbab9123fea841605fb665ef1e6ee4cd6ff4ef133ad0857e2269ccd99e81fed539c7d4283d6c085fd4af32f7b591e3cf656a0aa70cfe95f6bffb08c4eef9e391
+  metadata.gz: 31fa9cf1b50555a864c418319025a583b90d5bdc850c32e42e1ceaa7ea9272e442f0f6528dbd6e5b884c41cc8020271ff52415b7b96b7f2ed552b3c72e72902c
+  data.tar.gz: 3ba77bc89cbeb323f0777b963a8d43cce073e2606be5006e72a47ff259d17000d0080b3b46ee007b25d73f3a3bdc330e91606beede23c92a247c5b71b135df1b

data/.gitignore

@@ -7,3 +7,6 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store
+*.iml
+.idea/

data/README.md

@@ -2,41 +2,62 @@
 
 [![Build Status](https://travis-ci.org/nicholasjackson/minke-generator-go.svg?branch=master)](https://travis-ci.org/nicholasjackson/minke-generator-go)  
 
-This generator creates a REST API microservice in Golang.
+This generator creates a REST API Microservice in Go for the Minke build and test system.
 
-## Available variables for template (erb style)
-- <%= application_name %>: The name of the application executable
-- <%= namespace %>: Namespace of the application
+For information on Minke please see the documentation [http://nicholasjackson.github.io/minke/](http://nicholasjackson.github.io/minke/).
 
-## Testing your template
-```
-$ bundle
-```
-
-Test your generator by running ...
-```
-$ bundle exec minke -g minke-generator-template -o ../temp -a tester -n mynamespace
-```
+## Available variables for templates (erb style)
+| Variable                | Description                            |
+| ----------------------- |                                        |
+| <%= application_name %> | The name of the application executable |
+| <%= namespace %>        | Namespace of the application           |
+| <%= src_root %>         | Source root of the application         |
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'minke-generator-template'
+gem 'minke'
+gem 'minke-generator-go'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself:
+
+```
+$ gem install minke
+$ gem install minke-generator-go
 
-    $ gem install minke-generator-template
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+To scaffold a new service run:
+
+```bash
+$ minke -g minke-generator-go -o $GOPATH/src/github.com/nicholasjackson/helloworld
+  -a helloworld -n github.com/nicholasjackson
+```
+
+## Build and test with Docker
+To run a build with a Docker container, to execute the functional and unit tests you can use the following commands.  Please see the main Minke documentation for more information [http://nicholasjackson.github.io/minke/](http://nicholasjackson.github.io/minke/).
+
+### Build Application Code and Execute Unit tests
+```bash
+$ cd _build
+$ bundle
+$ rake app:test
+```
+
+### Build a Docker image and execute functional tests with Cucumber
+```bash
+$ rake app:build_image
+$ rake app:cucumber
+```
 
 ## Development
 
@@ -46,7 +67,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/minke-generator-template. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicholasjackson/minke-generator-netmvc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/generators/gomicroservice/scaffold/_build/Gemfile

@@ -4,8 +4,8 @@ gem "rake"
 gem 'cucumber-api', '~> 0.3'
 gem 'nokogiri'
 
-#gem 'minke'
-#gem 'minke-generator-go'
+gem 'minke'
+gem 'minke-generator-go'
 
-gem 'minke', :path => '/Users/nicj/Developer/gems/minke'
-gem 'minke-generator-go', :path => '/Users/nicj/Developer/gems/minke-generator-go'
+#gem 'minke', :path => '/Users/nicj/Developer/gems/minke'
+#gem 'minke-generator-go', :path => '/Users/nicj/Developer/gems/minke-generator-go'

data/lib/generators/gomicroservice/scaffold/_build/config.yml.erb

@@ -13,6 +13,9 @@ docker:
   application_docker_file: './dockerfile/<%= application_name %>/'
   application_compose_file: './dockercompose/<%= application_name %>/docker-compose.yml'
 fetch:
+  enabled: true
+test:
+  enabled: true
 build:
   post:
     copy:
@@ -30,7 +33,6 @@ run:
         address: consul
         port: 8500
         type: private
-test:
 cucumber:
   pre:
     consul_loader:

data/lib/generators/gomicroservice/scaffold/_build/dockercompose/<%= application_name %>/docker-compose.yml.erb

@@ -1,4 +1,5 @@
 version: '2'
+
 services:
   <%= application_name %>:
     image: <%= application_name %>
@@ -9,6 +10,7 @@ services:
     links:
       - consul:consul
       - statsd:statsd
+      - syslog:syslog
   consul:
     image: progrium/consul
     ports:
@@ -22,7 +24,7 @@ services:
     expose:
       - "8125/udp"
     environment:
-      - "SERVICE_NAME=statsd"
+      - "SERVICE_8125_NAME=statsd-8125"
   registrator:
     image: 'gliderlabs/registrator:latest'
     links:
@@ -30,3 +32,8 @@ services:
     command: '-internal -tags=dev consul://consul:8500'
     volumes:
       - '/var/run/docker.sock:/tmp/docker.sock'
+  syslog:
+    image: 'factorish/syslog'
+    command: '-t udp'
+    environment:
+      - "SERVICE_514_NAME=syslog-514"

data/lib/generators/gomicroservice/scaffold/_build/dockercompose/<%= application_name %>/docker-no-server.yml.erb

@@ -1,4 +1,5 @@
 version: '2'
+
 services:
   consul:
     image: progrium/consul
@@ -13,13 +14,16 @@ services:
     expose:
       - "8125/udp"
     environment:
-      - "SERVICE_NAME=statsd"
+      - "SERVICE_8125_NAME=statsd-8125"
   registrator:
     image: 'gliderlabs/registrator:latest'
     links:
       - consul:consul
-    environment:
-      - "SERVICE_NAME=statsd"
     command: '-internal -tags=dev consul://consul:8500'
     volumes:
       - '/var/run/docker.sock:/tmp/docker.sock'
+  syslog:
+    image: 'factorish/syslog'
+    command: '-t udp'
+    environment:
+      - "SERVICE_514_NAME=syslog-514"

data/lib/generators/gomicroservice/scaffold/_build/dockerfile/<%= application_name %>/config.ctmpl.erb

@@ -1,3 +1,4 @@
 {
-  "stats_d_server": "{{key "<%= application_name %>/Settings/statsd/host"}}:{{key "<%= application_name %>/Settings/statsd/port"}}"
+  "stats_d_server": "{{range service "statsd-8125"}}{{.Address}}:{{.Port}}{{end}}",
+  "syslog_server": "{{range $index, $element := service "syslog-514"}}{{if eq $index 0}}{{.Address}}:{{.Port}}{{end}}{{end}}"
 }

data/lib/generators/gomicroservice/scaffold/global/global.go

@@ -8,6 +8,7 @@ import (
 
 type ConfigStruct struct {
 	StatsDServerIP string `json:"stats_d_server"`
+	SysLogIP       string `json:"syslog_server"`
 	RootFolder     string
 }
 

data/lib/generators/gomicroservice/scaffold/handlers/echo.go.erb

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"log"
 
 	"github.com/gorilla/context"
 	"<%= namespace %>/<%= application_name %>/logging"
@@ -11,9 +12,11 @@ import (
 
 type EchoDependenciesContainer struct {
 	StatsD logging.StatsD `inject:"statsd"`
+	Log    *log.Logger    `inject:""`
 }
 
 var EchoDependencies *EchoDependenciesContainer = &EchoDependenciesContainer{}
+const EHTAGNAME = "EchoHandler: "
 
 // use the validation middleware to automatically validate input
 // github.com/asaskevich/govalidator
@@ -23,6 +26,7 @@ type Echo struct {
 
 func EchoHandler(rw http.ResponseWriter, r *http.Request) {
 	EchoDependencies.StatsD.Increment(ECHO_HANDLER + POST + CALLED)
+	EchoDependencies.Log.Printf("%v Called GET\n", EHTAGNAME)
 
 	// request is set into the context from the middleware
 	request := context.Get(r, "request").(*Echo)

data/lib/generators/gomicroservice/scaffold/handlers/echo_test.go.erb

@@ -27,6 +27,7 @@ func echoTestSetup(t *testing.T) {
 	err := g.Provide(
 		&inject.Object{Value: EchoDependencies},
 		&inject.Object{Value: echoStatsDMock, Name: "statsd"},
+		&inject.Object{Value: log.New(os.Stdout, "tester", log.Lshortfile)},
 	)
 
 	if err != nil {

data/lib/generators/gomicroservice/scaffold/handlers/health.go.erb

@@ -3,6 +3,7 @@ package handlers
 import (
 	"encoding/json"
 	"net/http"
+	"log"
 
 	"<%= namespace %>/<%= application_name %>/logging"
 )
@@ -31,6 +32,9 @@ type HealthDependenciesContainer struct {
 	// statsD interface must use a name type as injection cannot infer ducktypes
 	Stats logging.StatsD `inject:"statsd"`
 
+	// reference to the log writer
+	Log   *log.Logger     `inject:""`
+
 	// if not specified in the graph will automatically create private instance
 	PrivateBuilder *HealthResponseBuilder `inject:"private"`
 }
@@ -40,10 +44,12 @@ type HealthResponse struct {
 }
 
 var HealthDependencies *HealthDependenciesContainer = &HealthDependenciesContainer{}
+const HHTAGNAME = "HealthHandler: "
 
 func HealthHandler(rw http.ResponseWriter, r *http.Request) {
 	// all HealthHandlerDependencies are automatically created by injection process
 	HealthDependencies.Stats.Increment(HEALTH_HANDLER + GET + CALLED)
+	HealthDependencies.Log.Printf("%v Called GET\n", HHTAGNAME)
 
 	response := HealthDependencies.SingletonBuilder.SetStatusMessage("OK").Build()
 

data/lib/generators/gomicroservice/scaffold/handlers/health_test.go.erb

@@ -25,6 +25,7 @@ func healthTestSetup(t *testing.T) {
 	err := g.Provide(
 		&inject.Object{Value: HealthDependencies},
 		&inject.Object{Value: healthStatsDMock, Name: "statsd"},
+		&inject.Object{Value: log.New(os.Stdout, "tester", log.Lshortfile)},
 	)
 
 	if err != nil {

data/lib/generators/gomicroservice/scaffold/main.go.erb

@@ -4,6 +4,8 @@ import (
 	"fmt"
 	"net/http"
 	"os"
+	"log"
+	"log/syslog"
 	"<%= namespace %>/<%= application_name %>/global"
 	"<%= namespace %>/<%= application_name %>/handlers"
 
@@ -38,11 +40,19 @@ func setupInjection() {
 		panic(fmt.Sprintln("Unable to create StatsD Client: ", err))
 	}
 
+	syslogWriter, err := syslog.Dial("udp", global.Config.SysLogIP, syslog.LOG_SYSLOG, "sorcery")
+	if err != nil {
+		panic(fmt.Sprintln("Unable to connect to syslog: ", err))
+	}
+
+	logWriter := log.New(syslogWriter, "<%= application_name %>: ", log.Lshortfile)
+
 	err = g.Provide(
 		&inject.Object{Value: handlers.RouterDependencies},
 		&inject.Object{Value: handlers.HealthDependencies},
 		&inject.Object{Value: handlers.EchoDependencies},
 		&inject.Object{Value: statsdClient, Name: "statsd"},
+		&inject.Object{Value: logWriter},
 	)
 
 	if err != nil {

data/lib/generators/gomicroservice/version.rb

@@ -1,7 +1,7 @@
 module Minke
   module Generators
     module GoMicroservice
-      VERSION = "0.1.0"
+      VERSION = "0.4.0"
     end
   end
 end

data/lib/generators/gomicroservice.rb

@@ -12,16 +12,18 @@ module Minke
       config.template_location = File.expand_path(File.dirname(__FILE__)) + '/gomicroservice/scaffold'
 
       config.build_settings = Minke::Generators::BuildSettings.new
+
       config.build_settings.build_commands = Minke::Generators::BuildCommands.new.tap do |bc|
         bc.fetch = [['/bin/bash', '-c', 'go get -t -v -d ./... && echo Downloaded packages']]
         bc.build = [['/bin/bash', '-c', 'go build -a -installsuffix cgo -ldflags \'-s\' -o <%= application_name %>']]
         bc.test = [['/bin/bash', '-c', 'go test ./...']]
       end
+
       config.build_settings.docker_settings = Minke::Generators::DockerSettings.new.tap do |bs|
         bs.image = 'golang:latest'
         bs.env = ['CGO_ENABLED=0']
         bs.binds = ["#{ENV['GOPATH']}/src:/go/src"]
-        #bs.working_directory = 'sdsds'#{}"#{self.working_directory}"
+        # working directory is added via a class patch to enable lazy load
       end
 
       # we need lazy evaluation of this property

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minke-generator-go
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nic Jackson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-19 00:00:00.000000000 Z
+date: 2016-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Go microservice template for Minke