Merge branch 'master' into task-update-go

Author: dfeyer

Dockerfile

@@ -1,9 +1,30 @@
-FROM golang:latest
+#
+# Compile step
+FROM golang:alpine AS build-env
+ENV GOPATH=/gopath
+ENV PATH=$GOPATH/bin:$PATH
+ADD . /gopath/src/github.com/dfeyer/flow-debugproxy
+RUN apk update && \
+    apk upgrade && \
+    apk add git
+RUN cd /gopath/src/github.com/dfeyer/flow-debugproxy \
+  && go get \
+  && CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o flow-debugproxy
 
-WORKDIR /go/src/github.com/dfeyer/flow-debugproxy
-COPY . .
+#
+# Build step
+FROM alpine
+WORKDIR /app
 
-RUN go get -v
-RUN go install -v
+COPY --from=build-env /gopath/src/github.com/dfeyer/flow-debugproxy/flow-debugproxy /app/
 
-CMD ["flow-debugproxy"]
+ENV ADDITIONAL_ARGS ""
+
+ENV XDEBUG_PORT 9010
+
+ENV IDE_IP 127.0.0.1
+ENV IDE_PORT 9000
+
+ENV FRAMEWORK "flow"
+
+ENTRYPOINT ["sh", "-c", "./flow-debugproxy --xdebug 0.0.0.0:${XDEBUG_PORT} --framework ${FRAMEWORK} --ide ${IDE_IP}:${IDE_PORT} ${ADDITIONAL_ARGS}"]

README.md

@@ -43,40 +43,65 @@ Show help
 Use with Docker
 ---------------
 
-##### 1. Preparation:
-
-You will need:
-1. Your (W)LAN IP address.
-2. Your docker-machine's IP address. CMD: `docker-machine ip default` (use 127.0.0.1 on linux)
-3. A compiled flow-debugproxy binary
-4. Access to the PHP container's php.ini
-5. xdebug must be working
-
-##### 2. Installation & Debugging:
-
-1. Copy the flow-debugproxy binary to your container or a mounted folder.
-2. Identify and set these environment variables or replace them in the upcoming commands:
-* `HOST_IP` (Primary (W)LAN address of your device)
-* `XDEBUG_PORT` (PhpStorm settings: Language & Framework -> PHP -> Debug: Xdebug: Debug Port)
-* `FLOW_DEBUG_BIN_PATH` (The path of the binary **inside** the container)
-3. Set following php.ini values in your php/web container: (xdebug will now try to (only) connect to the php container itself.)
+Use the [official docker image](https://hub.docker.com/r/dfeyer/flow-debugproxy/) and follow the instruction for the configuration.
+
+##### PHP configuration
+
 ```
-xdebug.remote_host = 127.0.0.1
-xdebug.remote_port = 9002
+[Xdebug]
+zend_extension=/.../xdebug.so
+xdebug.remote_enable=1
+xdebug.idekey=PHPSTORM
+; The IP or name of the proxy container
+xdebug.remote_host=debugproxy
+; The proxy port (9010 by default, to not have issue is you use PHP FPM, already on port 9000)
+xdebug.remote_port=9010
+;xdebug.remote_log=/tmp/xdebug.log
 ```
-4. Start the debug proxy (Replace `$(docker-compose ps -q app)` with your container if you don't use docker-compose)
+
+You can use the `xdebug.remote_log` to debug the protocol between your container and the proxy, it's useful to catch network issues.
+
+##### Docker Compose
+
+This is an incomplete Docker Compose configuration:
+
 ```
-docker exec -e PHP_IDE_CONFIG='serverName=app' $(docker-compose ps -q app) ${FLOW_DEBUG_BIN_PATH} --xdebug 0.0.0.0:9002 --ide ${HOST_IP}:${XDEBUG_PORT} > /dev/null &
+services:
+  debugproxy:
+    image: dfeyer/flow-debugproxy:latest
+    volumes:
+      - .:/data
+    environment:
+      # This MUST be the IP address of the IDE (your computer)
+      - "IDE_IP=192.168.1.130"
+      # This is the default value, need to match the xdebug.remote_port on your php.ini
+      - "XDEBUG_PORT=9010"
+      # Use this to enable verbose debugging on the proxy
+      # - "ADDITIONAL_ARGS=-vv --debug"
+    networks:
+      - backend
+
+  # This is your application containers, you need to link it to the proxy
+  app:
+    # The proxy need an access to the project files, to be able to do the path mapping
+    volumes:
+      - .:/data
+    links:
+      - debugproxy
 ```
-5. Enable your IDE's xdebug listener, ensure xdebug is enabled (e.g. if you use bookm)
-6. Use `xdebug_break()` in your code to force your first break.
-7. The first time you have to configure your IDE with the popup that should open on the first `xdebug_break();` hit. (Or "Click to set up path mappings" in your debug console UI)
-If not, configure your PHP Server settings yourself.
 
-Debugging the debugger:
+**Options summary:**
+* `IDE_IP` The primary local W-/LAN IP of your machine where your IDE runs on
+* `IDE_PORT` The Port your IDE is listening for incoming xdebug connections. (The port the debug proxy will try to connect to)
+* `XDEBUG_PORT` The port on which xdebug will try to establish a connection (to this container)
+* `FRAMEWORK` Currently supported values: `flow` and `dummy`
+* `ADDITIONAL_ARGS` For any additional argument like verbosity flags (`-vv`) or debug mode (`--debug`) (or both)
+
+**Debugging the debugger**
 
 Start the debug proxy with verbose flags if it does not connect to your IDE.
-The debug proxy does not quit after stopping the process that started it. You have to kill it in the container manually.
+The debug proxy does not quit after stopping the process that started it.
+You have to kill it in the container manually.
 
 Hint:
 
@@ -88,9 +113,11 @@ proxy classes.
 FLOW_PATH_TEMPORARY_BASE=/tmp/flow/Data/Temporary
 ```
 
-##### Using with --framework dummy
+Using with --framework dummy
+----------------------------
+
+If your debugging target is the code generated by Flow's AOP Framework then you can start the debugging proxy with `--framework dummy`.
 
-If your debugging target is the code generated by Flow's AOP Framework then you can start the debugging proxy with --framework dummy
 In that case it won't remap from the generated code to your source but "pass through" the debugger steps.
 To see what's going on you have to have the generated code in a folder visible to your IDE (in your project).
 You can either abstain from `FLOW_PATH_TEMPORARY_BASE` or set it to a path that is in your IDE's project.

go.mod

@@ -0,0 +1,10 @@
+module github.com/dfeyer/flow-debugproxy
+
+go 1.13
+
+require (
+	github.com/clbanning/mxj v1.8.4
+	github.com/mattn/go-colorable v0.1.4 // indirect
+	github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b
+	github.com/urfave/cli v1.22.2
+)

go.sum

@@ -0,0 +1,22 @@
+github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
+github.com/clbanning/mxj v1.8.4 h1:HuhwZtbyvyOw+3Z1AowPkU87JkJUSv751ELWaiTpj8I=
+github.com/clbanning/mxj v1.8.4/go.mod h1:BVjHeAH+rl9rs6f+QIpeRl0tfu10SXn1pUSa5PVGJng=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY=
+github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU=
+github.com/mattn/go-colorable v0.1.4 h1:snbPLB8fVfU9iwbbo30TPtbLRzwWu6aJS6Xh4eaaviA=
+github.com/mattn/go-colorable v0.1.4/go.mod h1:U0ppj6V5qS13XJ6of8GYAs25YV2eR4EVcfRqFIhoBtE=
+github.com/mattn/go-isatty v0.0.8 h1:HLtExJ+uU2HOZ+wI0Tt5DtUDrx8yhUqDcp7fYERX4CE=
+github.com/mattn/go-isatty v0.0.8/go.mod h1:Iq45c/XA43vh69/j3iqttzPXn0bhXyGjM0Hdxcsrc5s=
+github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b h1:j7+1HpAFS1zy5+Q4qx1fWh90gTKwiN4QCGoY9TWyyO4=
+github.com/mgutz/ansi v0.0.0-20170206155736-9520e82c474b/go.mod h1:01TrycV0kFyexm33Z7vhZRXopbI8J3TDReVlkTgMUxE=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q=
+github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
+github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo=
+github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc=
+github.com/urfave/cli v1.22.2 h1:gsqYFH8bb9ekPA12kRo0hfjngWQjkJPlN9R0N78BoUo=
+github.com/urfave/cli v1.22.2/go.mod h1:Gos4lmkARVdJ6EkW0WaNv/tZAAMe9V7XWyB60NtXRu0=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223 h1:DH4skfRX4EBpamg7iV4ZlCpblAHI6s6TDM39bFZumv8=
+golang.org/x/sys v0.0.0-20190222072716-a9d3bda3a223/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

main.go

@@ -17,7 +17,7 @@ import (
 	_ "github.com/dfeyer/flow-debugproxy/dummypathmapper"
 	_ "github.com/dfeyer/flow-debugproxy/flowpathmapper"
 
-	"github.com/codegangsta/cli"
+	"github.com/urfave/cli"
 
 	"net"
 	"os"
@@ -28,51 +28,49 @@ func main() {
 	app := cli.NewApp()
 	app.Name = "flow-debugproxy"
 	app.Usage = "Flow Framework xDebug proxy"
-	app.Author = "Dominique Feyer"
-	app.Email = "dominique@neos.io"
 	app.Version = "1.0.1"
 
 	app.Flags = []cli.Flag{
-		cli.StringFlag{
+		&cli.StringFlag{
 			Name:  "xdebug, l",
 			Value: "127.0.0.1:9000",
 			Usage: "Listen address IP and port number",
 		},
-		cli.StringFlag{
+		&cli.StringFlag{
 			Name:  "ide, I",
 			Value: "127.0.0.1:9010",
 			Usage: "Bind address IP and port number",
 		},
-		cli.StringFlag{
+		&cli.StringFlag{
 			Name:  "context, c",
 			Value: "Development",
 			Usage: "The context to run as",
 		},
-		cli.StringFlag{
+		&cli.StringFlag{
 			Name:  "localroot, r",
 			Value: "",
 			Usage: "Local project root for remote debugging",
 		},
-		cli.StringFlag{
+		&cli.StringFlag{
 			Name:  "framework",
 			Value: "flow",
 			Usage: "Framework support, currently on Flow framework (flow) or Dummy (dummy) is supported",
 		},
-		cli.BoolFlag{
+		&cli.BoolFlag{
 			Name:  "verbose",
 			Usage: "Verbose",
 		},
-		cli.BoolFlag{
+		&cli.BoolFlag{
 			Name:  "vv",
 			Usage: "Very verbose",
 		},
-		cli.BoolFlag{
+		&cli.BoolFlag{
 			Name:  "debug",
 			Usage: "Show debug output",
 		},
 	}
 
-	app.Action = func(cli *cli.Context) {
+	app.Action = func(cli *cli.Context) error {
 		c := &config.Config{
 			Context:     cli.String("context"),
 			Framework:   cli.String("framework"),