Refactor package name (opendistro-for-elasticsearch#14)

delete odfe-cli folder inside repo and update package path
accordingly.

Author: VijayanB

.github/workflows/odfe-cli-test-build-workflow.yml

@@ -11,25 +11,21 @@ on:
 
 jobs:
   test:
-    defaults:
-      run:
-        working-directory: odfe-cli
     runs-on: ubuntu-latest
     steps:
       - name: Set up Go ubuntu-latest
         uses: actions/setup-go@v2
         with:
           go-version: 1.14
 
+      - name: Install goimports
+        run:  go get golang.org/x/tools/cmd/goimports
+
       - name: Check out source code
         uses: actions/checkout@v2
 
       - name: Format check
-        run: |
-          cd ..
-          go get golang.org/x/tools/cmd/goimports
-          cd odfe-cli
-          goimports -w .
+        run: goimports -w .
 
       - name: Check for modified files
         id: git-check
@@ -47,7 +43,6 @@ jobs:
         uses: golangci/golangci-lint-action@v1
         with:
           version: v1.28
-          working-directory: odfe-cli
 
       - name: Run Unit Tests
         env:
@@ -70,14 +65,11 @@ jobs:
         uses: codecov/codecov-action@v1.0.3
         with:
           token: ${{secrets.CODECOV_TOKEN}}
-          file: odfe-cli/coverage.out
+          file: coverage.out
           flags: odfe-cli
           name: codecov-umbrella
 
   build:
-    defaults:
-      run:
-        working-directory: odfe-cli
     strategy:
       matrix:
         platform: [ ubuntu-latest, macos-latest, windows-latest ]

odfe-cli/.gitignore .gitignore

@@ -1,7 +1,140 @@
-## ODFE Command Line Interface
+![Build and Test odfe-cli](https://github.com/opendistro-for-elasticsearch/odfe-cli/workflows/Build%20and%20Test%20odfe-cli/badge.svg?branch=main)
+[![codecov](https://codecov.io/gh/opendistro-for-elasticsearch/odfe-cli/branch/main/graph/badge.svg?flag=odfe-cli)](https://codecov.io/gh/opendistro-for-elasticsearch/odfe-cli)
+![PRs welcome!](https://img.shields.io/badge/PRs-welcome!-success)
+# ODFE Command Line Interface
+
+ODFE Command Line Interface (odfe-cli) is an open source tool that lets you manage your Open Distro for Elasticsearch
+cluster from the command line and automate tasks. In addition to standard Elasticsearch operations, you can configure,
+manage, and use the ODFE plugins, such as Alerting, Anomaly Detection, and SQL
+
+odfe-cli is best suited for situations in which you want to quickly combine a few commands, possibly adding them to
+a script for easy access or automation. This example moves a detector "ecommerce-count-qualtity" from staging
+to prod cluster, provided both profiles are available in config file.
+
+```
+odfe-cli ad get ecommerce-count-qualtity --profile stg > ecommerce-count-qualtity.json
+odfe-cli ad create ecommerce-count-qualtity.json --profile prod
+odfe-cli ad start ecommerce-count-qualtity.json --profile prod
+odfe-cli ad stop ecommerce-count-qualtity --profile stg
+odfe-cli ad delete ecommerce-count-qualtity --profile stg
+```
+## Installation:
+
+You can download the binaries directly from the [downloads](https://opendistro.github.io/for-elasticsearch/downloads.html) page
+or from the [releases](https://github.com/opendistro-for-elasticsearch/odfe-cli/releases) section.
+
+
+## Development
+
+### Minimum requirements
+
+odfe-cli shares [minimum requirements](https://github.com/golang/go/wiki/MinimumRequirements#minimum-requirements) as Go
+and [docker](https://docs.docker.com/get-docker/) to run integration tests.
+
+### Build from source
+1. Install [Go](https://golang.org/doc/install) > = 1.14
+2. Clone the repository:
+    ```
+    cd $GOPATH/src
+    git clone git@github.com:opendistro-for-elasticsearch/odfe-cli.git
+    ```
+3. Run build from source directory to generate binary:
+   ```
+   cd odfe-cli
+   go build .
+   ```
+4. Make binary executable:
+    ```
+    chmod +x ./odfe-cli
+    ```
+
+### Unit Testing
+Go has a simple tool for running tests. To run every unit test, use this command:
+ ```
+go test ./...
+```
+ 
+However, often when writing tests, you may want to run your new test as below
+```
+cd folder-path/to/test;
+go test -v -run TestName; 
+```
+
+### Integration Testing
+In order to test odfe-cli end-to-end, we need a running odfe cluster. We can use Docker to accomplish this. 
+The [Docker Compose file](./docker-compose.yml) supports the ability to run integration tests for the project in local environments respectively.
+If you have not installed docker-compose, you can install it from this [link](https://docs.docker.com/compose/install/)
+
+Integration tests are often slower, so you may want to only run them after the unit test. In order to differentiate unit tests from integration tests, Go has a built-in mechanism for allowing you to logically separate your tests
+with build tags. The build tag needs to be placed as close to the top of the file as possible, and must have a blank line beneath it.   
+We recommend you to create all integration tests inside [this](./it) folder with build tag 'integration'.
+
+#### Execute test integration command from your CLI
+1. Run docker compose to start containers, by default it will launch latest odfe version.
+    ```
+    docker-compose up -d;
+    ```
+2. Run all integration tests with build tag 'integration'
+    ```
+    go test -tags=integration ./it/...
+    ```
+
+## Usage
+
+```
+odfe-cli --help
+```
+
+### Create default profile
+A profile is a collection of credentials that will be applied to the odfe-cli command. When a user specifies a profile, 
+the settings and credentials of that profile will be used to execute the command.
+Users can create one profile with the name "default", and is used when no profile is explicitly referenced. 
+
+```
+$ odfe-cli profile create
+Enter profile's name: default
+Elasticsearch Endpoint: https://localhost:9200  
+User Name: admin
+Password: 
+```
+
+### List existing profile
+
+```
+$ odfe-cli profile list -l
+Name         UserName            Endpoint-url             
+----         --------            ------------              
+default      admin               https://localhost:9200   
+prod         admin               https://odfe-node1:9200
+                 
+```
+
+### Using profile with odfe-cli command
+
+You can specify profiles in two ways.
+
+1. The first way is to add the --profile <name> option:    
+    ```
+    $ odfe-cli ad stop-detector invalid-logins --profile prod
+    ```
+    This example stops the invalid-logins detector using the credentials and settings in the prod profile.
+    
+2. The second way is to use an environment variable.
+
+    On Linux or macOS :
+    ```
+    $ export ODFE_PROFILE=prod
+    ```
+    Windows
+    ```
+    C:\> setx ODFE_PROFILE prod
+    ```
+   These variables last for the duration of your shell session, but you can add them to .zshenv or .bash_profile
+   for a more permanent option.
+    
 ## Security
 
-See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+See [CONTRIBUTING](https://github.com/opendistro-for-elasticsearch/odfe-cli/blob/main/CONTRIBUTING.md#security-issue-notifications) for more information.
 
 ## License
 

odfe-cli/Makefile Makefile

@@ -16,9 +16,10 @@
 package mocks
 
 import (
-	"es-cli/odfe-cli/client"
 	"fmt"
 	"net/http"
+	"odfe-cli/client"
+	"os"
 )
 
 // RoundTripFunc .
@@ -32,8 +33,9 @@ func (f RoundTripFunc) RoundTrip(req *http.Request) (*http.Response, error) {
 //NewTestClient returns *http.Client with Transport replaced to avoid making real calls
 func NewTestClient(fn RoundTripFunc) *client.Client {
 	c, err := client.New(fn)
-	if err == nil {
+	if err != nil {
 		fmt.Println("Fatal: failed to get client")
+		os.Exit(1)
 	}
 	return c
 }

README.md

@@ -16,13 +16,13 @@
 package commands
 
 import (
-	"es-cli/odfe-cli/client"
-	adctrl "es-cli/odfe-cli/controller/ad"
-	esctrl "es-cli/odfe-cli/controller/es"
-	adgateway "es-cli/odfe-cli/gateway/ad"
-	esgateway "es-cli/odfe-cli/gateway/es"
-	handler "es-cli/odfe-cli/handler/ad"
 	"fmt"
+	"odfe-cli/client"
+	adctrl "odfe-cli/controller/ad"
+	esctrl "odfe-cli/controller/es"
+	adgateway "odfe-cli/gateway/ad"
+	esgateway "odfe-cli/gateway/es"
+	handler "odfe-cli/handler/ad"
 	"os"
 
 	"github.com/spf13/cobra"

odfe-cli/client/http.go client/http.go

@@ -16,8 +16,8 @@
 package commands
 
 import (
-	handler "es-cli/odfe-cli/handler/ad"
 	"fmt"
+	handler "odfe-cli/handler/ad"
 
 	"github.com/spf13/cobra"
 )

odfe-cli/client/mocks/mock_http.go client/mocks/mock_http.go

@@ -16,8 +16,8 @@
 package commands
 
 import (
-	handler "es-cli/odfe-cli/handler/ad"
 	"fmt"
+	handler "odfe-cli/handler/ad"
 
 	"github.com/spf13/cobra"
 )

odfe-cli/commands/ad.go commands/ad.go

@@ -17,10 +17,10 @@ package commands
 
 import (
 	"encoding/json"
-	entity "es-cli/odfe-cli/entity/ad"
-	"es-cli/odfe-cli/handler/ad"
 	"fmt"
 	"io"
+	entity "odfe-cli/entity/ad"
+	"odfe-cli/handler/ad"
 	"os"
 
 	"github.com/spf13/cobra"

odfe-cli/commands/ad_create.go commands/ad_create.go

@@ -16,8 +16,8 @@
 package commands
 
 import (
-	"es-cli/odfe-cli/handler/ad"
 	"fmt"
+	"odfe-cli/handler/ad"
 
 	"github.com/spf13/cobra"
 )

odfe-cli/commands/ad_delete.go commands/ad_delete.go

@@ -16,8 +16,8 @@
 package commands
 
 import (
-	handler "es-cli/odfe-cli/handler/ad"
 	"fmt"
+	handler "odfe-cli/handler/ad"
 
 	"github.com/spf13/cobra"
 )

odfe-cli/commands/ad_get.go commands/ad_get.go

@@ -16,10 +16,10 @@
 package commands
 
 import (
-	"es-cli/odfe-cli/controller/config"
-	"es-cli/odfe-cli/controller/profile"
-	"es-cli/odfe-cli/entity"
 	"fmt"
+	"odfe-cli/controller/config"
+	"odfe-cli/controller/profile"
+	"odfe-cli/entity"
 	"os"
 	"strings"
 	"text/tabwriter"

odfe-cli/commands/ad_start_stop.go commands/ad_start_stop.go

@@ -17,10 +17,10 @@ package commands
 
 import (
 	"errors"
-	"es-cli/odfe-cli/controller/profile/mocks"
-	"es-cli/odfe-cli/entity"
 	"fmt"
 	"io/ioutil"
+	"odfe-cli/controller/profile/mocks"
+	"odfe-cli/entity"
 	"os"
 	"testing"
 

odfe-cli/commands/ad_update.go commands/ad_update.go

@@ -16,13 +16,13 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
-	"es-cli/odfe-cli/controller/es"
-	entity "es-cli/odfe-cli/entity/ad"
-	"es-cli/odfe-cli/gateway/ad"
-	"es-cli/odfe-cli/mapper"
-	admapper "es-cli/odfe-cli/mapper/ad"
 	"fmt"
 	"io"
+	"odfe-cli/controller/es"
+	entity "odfe-cli/entity/ad"
+	"odfe-cli/gateway/ad"
+	"odfe-cli/mapper"
+	admapper "odfe-cli/mapper/ad"
 	"os"
 	"strings"
 

odfe-cli/commands/profile.go commands/profile.go

@@ -17,12 +17,12 @@ import (
 	"context"
 	"encoding/json"
 	"errors"
-	esmockctrl "es-cli/odfe-cli/controller/es/mocks"
-	entity "es-cli/odfe-cli/entity/ad"
-	adgateway "es-cli/odfe-cli/gateway/ad/mocks"
-	"es-cli/odfe-cli/mapper"
 	"fmt"
 	"io/ioutil"
+	esmockctrl "odfe-cli/controller/es/mocks"
+	entity "odfe-cli/entity/ad"
+	adgateway "odfe-cli/gateway/ad/mocks"
+	"odfe-cli/mapper"
 	"os"
 	"path/filepath"
 	"testing"

odfe-cli/commands/profile_test.go commands/profile_test.go

@@ -16,8 +16,8 @@
 package config
 
 import (
-	"es-cli/odfe-cli/entity"
 	"io/ioutil"
+	"odfe-cli/entity"
 	"os"
 
 	"gopkg.in/yaml.v3"

odfe-cli/commands/root.go commands/root.go

@@ -16,9 +16,9 @@
 package config
 
 import (
-	"es-cli/odfe-cli/entity"
 	"fmt"
 	"io/ioutil"
+	"odfe-cli/entity"
 	"os"
 	"path/filepath"
 	"testing"