Merge pull request #17536 from deads2k/oc-01-restrict

Automatic merge from submit-queue (batch tested with PRs 17536, 17512).

 prevent references from origin to oc

Builds on #17516 and #17357

After this, oc can be deleted from origin during the next kube bump.

@juanvallejo missed one.  I hacked it in.  You'll want to pretty it up eventually.
@eparis @smarterclayton after this merges, I think we're good to branch 3.8.

Author: openshift-merge-robot

hack/import-restrictions.json

@@ -16,6 +16,22 @@
     ]
   },
 
+  {
+    "checkedPackageRoots": [
+      "github.com/openshift/origin/pkg"
+    ],
+    "ignoredSubTrees": [
+      "github.com/openshift/origin/pkg/oc"
+    ],
+    "forbiddenImportPackageRoots": [
+      "github.com/openshift/origin/pkg/oc"
+    ],
+    "allowedImportPackageRoots": [
+      "vendor",
+      ""
+    ]
+  },
+
   {
     "checkedPackageRoots": [
       "github.com/openshift/origin/pkg"

pkg/cmd/openshift/openshift.go

@@ -1,13 +1,17 @@
 package openshift
 
 import (
+	"flag"
 	"fmt"
+	"io"
 	"os"
 	"runtime"
 	"strings"
 
 	"github.com/spf13/cobra"
+	"github.com/spf13/pflag"
 
+	kcmd "k8s.io/kubernetes/pkg/kubectl/cmd"
 	ktemplates "k8s.io/kubernetes/pkg/kubectl/cmd/templates"
 	kcmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
 
@@ -20,7 +24,6 @@ import (
 	"github.com/openshift/origin/pkg/cmd/templates"
 	cmdutil "github.com/openshift/origin/pkg/cmd/util"
 	cmdversion "github.com/openshift/origin/pkg/cmd/version"
-	"github.com/openshift/origin/pkg/oc/cli/cmd"
 	osversion "github.com/openshift/origin/pkg/version/openshift"
 )
 
@@ -95,7 +98,7 @@ func NewCommandOpenShift(name string) *cobra.Command {
 	root.AddCommand(startAllInOne)
 	root.AddCommand(newCompletionCommand("completion", name+" completion"))
 	root.AddCommand(cmdversion.NewCmdVersion(name, osversion.Get(), os.Stdout))
-	root.AddCommand(cmd.NewCmdOptions(out))
+	root.AddCommand(newCmdOptions())
 
 	// TODO: add groups
 	templates.ActsAsRootCommand(root, []string{"options"})
@@ -104,6 +107,84 @@ func NewCommandOpenShift(name string) *cobra.Command {
 }
 
 func newCompletionCommand(name, fullName string) *cobra.Command {
-	return cmd.NewCmdCompletion(fullName, os.Stdout)
+	return NewCmdCompletion(fullName, os.Stdout)
 
 }
+
+// newCmdOptions implements the OpenShift cli options command
+func newCmdOptions() *cobra.Command {
+	cmd := &cobra.Command{
+		Use: "options",
+		Run: func(cmd *cobra.Command, args []string) {
+			cmd.Usage()
+		},
+	}
+
+	ktemplates.UseOptionsTemplates(cmd)
+
+	return cmd
+}
+
+// from here down probably deserves some common usage
+var (
+	completionLong = ktemplates.LongDesc(`
+		This command prints shell code which must be evaluated to provide interactive
+		completion of %s commands.`)
+
+	completionExample = ktemplates.Examples(`
+		# Generate the %s completion code for bash
+	  %s completion bash > bash_completion.sh
+	  source bash_completion.sh
+
+	  # The above example depends on the bash-completion framework.
+	  # It must be sourced before sourcing the openshift cli completion,
+		# i.e. on the Mac:
+
+	  brew install bash-completion
+	  source $(brew --prefix)/etc/bash_completion
+	  %s completion bash > bash_completion.sh
+	  source bash_completion.sh
+
+	  # In zsh*, the following will load openshift cli zsh completion:
+	  source <(%s completion zsh)
+
+	  * zsh completions are only supported in versions of zsh >= 5.2`)
+)
+
+func NewCmdCompletion(fullName string, out io.Writer) *cobra.Command {
+	cmdHelpName := fullName
+
+	if strings.HasSuffix(fullName, "completion") {
+		cmdHelpName = "openshift"
+	}
+
+	cmd := kcmd.NewCmdCompletion(out, "\n")
+	cmd.Long = fmt.Sprintf(completionLong, cmdHelpName)
+	cmd.Example = fmt.Sprintf(completionExample, cmdHelpName, cmdHelpName, cmdHelpName, cmdHelpName)
+	// mark all statically included flags as hidden to prevent them appearing in completions
+	cmd.PreRun = func(c *cobra.Command, _ []string) {
+		pflag.CommandLine.VisitAll(func(flag *pflag.Flag) {
+			flag.Hidden = true
+		})
+		hideGlobalFlags(c.Root(), flag.CommandLine)
+	}
+	return cmd
+}
+
+// hideGlobalFlags marks any flag that is in the global flag set as
+// hidden to prevent completion from varying by platform due to conditional
+// includes. This means that some completions will not be possible unless
+// they are registered in cobra instead of being added to flag.CommandLine.
+func hideGlobalFlags(c *cobra.Command, fs *flag.FlagSet) {
+	fs.VisitAll(func(flag *flag.Flag) {
+		if f := c.PersistentFlags().Lookup(flag.Name); f != nil {
+			f.Hidden = true
+		}
+		if f := c.LocalFlags().Lookup(flag.Name); f != nil {
+			f.Hidden = true
+		}
+	})
+	for _, child := range c.Commands() {
+		hideGlobalFlags(child, fs)
+	}
+}