Adding autocomplete to BBSimctl
Change-Id: I7853743deb319b7759180c0163473e6c03c4b9c5
diff --git a/README.md b/README.md
index 2cfd0fa..dbaa36e 100644
--- a/README.md
+++ b/README.md
@@ -132,6 +132,14 @@
3 4 BBSM00000304 900 915 up auth_failed
```
+### Autocomplete
+
+`bbsimctl` comes with autocomplete, just run:
+
+```bash
+source <(bbsimctl completion bash)
+```
+
## Documentation
More advanced documentation lives in the [here](./docs/README.md)
diff --git a/build/package/Dockerfile b/build/package/Dockerfile
index 46af0e3..e85888e 100644
--- a/build/package/Dockerfile
+++ b/build/package/Dockerfile
@@ -71,4 +71,5 @@
COPY --from=builder /go/src/github.com/opencord/bbsim/bbsimctl /usr/bin/bbsimctl
RUN chmod a+x /app/bbsim
RUN chmod a+x /usr/bin/bbsimctl
+RUN bbsimctl completion bash >> $HOME/.bashrc
CMD [ '/app/bbsim' ]
\ No newline at end of file
diff --git a/cmd/bbsimctl/bbsimctl.go b/cmd/bbsimctl/bbsimctl.go
index 29b45c5..e7fead0 100644
--- a/cmd/bbsimctl/bbsimctl.go
+++ b/cmd/bbsimctl/bbsimctl.go
@@ -37,6 +37,7 @@
commands.RegisterConfigCommands(parser)
commands.RegisterOltCommands(parser)
commands.RegisterONUCommands(parser)
+ commands.RegisterCompletionCommands(parser)
_, err = parser.ParseArgs(os.Args[1:])
if err != nil {
diff --git a/internal/bbsimctl/commands/completion.go b/internal/bbsimctl/commands/completion.go
new file mode 100644
index 0000000..d7ad19f
--- /dev/null
+++ b/internal/bbsimctl/commands/completion.go
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019-present Ciena Corporation
+ *
+ * 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.
+ */
+package commands
+
+import (
+ "fmt"
+ "github.com/jessevdk/go-flags"
+ "github.com/opencord/bbsim/internal/bbsimctl/completion"
+)
+
+type BashOptions struct{}
+
+type CompletionOptions struct {
+ BashOptions `command:"bash"`
+}
+
+func RegisterCompletionCommands(parent *flags.Parser) {
+ parent.AddCommand("completion", "generate shell compleition", "Commands to generate shell completion information", &CompletionOptions{})
+}
+
+func (options *BashOptions) Execute(args []string) error {
+ fmt.Println(completion.Bash)
+ return nil
+}
diff --git a/internal/bbsimctl/completion/bash.go b/internal/bbsimctl/completion/bash.go
new file mode 100644
index 0000000..67e731a
--- /dev/null
+++ b/internal/bbsimctl/completion/bash.go
@@ -0,0 +1,44 @@
+/*
+ * Copyright 2019-present Ciena Corporation
+ *
+ * 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.
+ */
+package completion
+
+const Bash = `
+# Portions copyright 2019-present Open Networking Foundation
+# Original copyright 2019-present Ciena Corporation
+#
+# 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.
+#
+_bbsimctl() {
+ # All arguments except the first one
+ args=("${COMP_WORDS[@]:1:$COMP_CWORD}")
+ # Only split on newlines
+ local IFS=$'\n'
+ # Call completion (note that the first element of COMP_WORDS is
+ # the executable itself)
+ COMPREPLY=($(GO_FLAGS_COMPLETION=1 ${COMP_WORDS[0]} "${args[@]}"))
+ return 0
+}
+complete -F _bbsimctl bbsimctl`