Merge pull request #4 from clarsonneur/list-installed

list jenkins plugins version from an installation

Author: clarsonneur

.gitignore

@@ -11,3 +11,6 @@
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
 .be-*
+
+vendor/
+jplugins

DESIGN.md

@@ -0,0 +1,9 @@
+# Application design
+
+Step: List existing plugins in a Jenkins installation
+
+1. cli with option
+    jplugins list-installed [--jenkins-home path]
+2. loop on files *.[hj]pi to determine plugin name
+3. read version in MANIFEST file
+4. print out the list

build-env.sh

@@ -3,5 +3,6 @@
 BE_PROJECT=jplugins
 
 # Add any module parameters here
+export CGO_ENABLED=0
 
 source lib/source-build-env.sh

glide.lock

@@ -0,0 +1,4 @@
+package: jplugins
+import:
+- package: github.com/alecthomas/kingpin
+  version: ^2.2.6

glide.yaml

@@ -0,0 +1,23 @@
+package main
+
+import (
+	"github.com/alecthomas/kingpin"
+)
+
+type jPluginsApp struct {
+	app *kingpin.Application
+
+	listInstalled *kingpin.CmdClause
+	jenkinsHomePath *string
+
+	installedPlugins plugins
+}
+
+func (a *jPluginsApp) init() {
+	a.app = kingpin.New("jplugins", "Jenkins plugins as Code management tool.")
+
+	a.setVersion()
+
+	a.listInstalled = a.app.Command("list-installed", "Display Jenkins plugins list of current Jenkins installation.")
+	a.jenkinsHomePath = a.listInstalled.Flag("jenkins-home", "Where Jenkins is installed.").Default("/var/jenkins_home").String()
+}

jplugins-app.go

@@ -0,0 +1,125 @@
+package main
+
+import (
+	"sort"
+	"fmt"
+	"io/ioutil"
+	"os"
+	"path"
+	"regexp"
+	"strings"
+
+	"github.com/forj-oss/forjj-modules/trace"
+	"gopkg.in/yaml.v2"
+)
+
+func (a *jPluginsApp) doListInstalled() {
+	if !a.readFromJenkins() {
+		return
+	}
+	a.printOutVersion(a.installedPlugins)
+}
+
+// readFromJenkins read manifest of each plugins and store information in a.installedPlugins
+func (a *jPluginsApp) readFromJenkins() (_ bool) {
+	pluginsPath := path.Join(*a.jenkinsHomePath, "plugins")
+
+	a.installedPlugins = make(plugins)
+
+	fEntries, err := ioutil.ReadDir(pluginsPath)
+
+	if err != nil {
+		gotrace.Error("Invalid Jenkins home '%s'. %s", pluginsPath, err)
+		return
+	}
+
+	var fileRE, manifestRE *regexp.Regexp
+	fileREDefine := `^(.*)\.[jh]pi*$`
+	manifestREDefine := `([\w-]*: )(.*)\n`
+
+	if re, err := regexp.Compile(fileREDefine); err != nil {
+		gotrace.Error("Internal error. Regex '%s': %s", fileREDefine, err)
+		return
+	} else {
+		fileRE = re
+
+	}
+	if re, err := regexp.Compile(manifestREDefine); err != nil {
+		gotrace.Error("Internal error. Regex '%s': %s", fileREDefine, err)
+		return
+	} else {
+		manifestRE = re
+	}
+
+	for _, fEntry := range fEntries {
+		if fEntry.IsDir() {
+			continue
+		}
+
+		if fileMatch := fileRE.FindAllStringSubmatch(fEntry.Name(), -1); fileMatch != nil {
+			pluginFileName := fileMatch[0][0]
+			pluginName := fileMatch[0][1]
+
+			if pluginFileName != "" && pluginName == "" {
+				gotrace.Error("Invalid file '%s'. Ignored.", pluginFileName)
+				continue
+			}
+
+			pluginMetafile := path.Join(pluginsPath, pluginName, "META-INF", "MANIFEST.MF")
+
+			if _, err := os.Stat(pluginMetafile); err != nil && os.IsNotExist(err) {
+				// TODO: Ignored for now. but may need to extract the plugin file to get the version
+				gotrace.Warning("Plugin '%s' found but not expanded. Ignored. (fix in next jplugins version)", pluginMetafile)
+				continue
+			}
+
+			var manifest *pluginManifest
+
+			if d, err := ioutil.ReadFile(pluginMetafile); err != nil {
+				gotrace.Error("Unable to read file '%s'. %s. Ignored", pluginMetafile, err)
+				continue
+			} else {
+				// Remove DOS format if exist
+				data := strings.Replace(string(d), "\r", "", -1)
+				// and remove new lines ('\n ')
+				data = strings.Replace(data, "\n ", "", -1)
+				// and escape "
+				data = strings.Replace(data, "\"", "\\\"", -1)
+				// and embrace value part with "
+				data = manifestRE.ReplaceAllString(data, `$1"$2"`+"\n")
+
+				manifest = new(pluginManifest)
+				if err := yaml.Unmarshal([]byte(data), &manifest); err != nil {
+					gotrace.Error("Unable to read file '%s' as yaml. %s. Ignored", pluginMetafile, err)
+					fmt.Print(data)
+					continue
+				}
+			}
+			a.installedPlugins[manifest.Name] = manifest
+		}
+	}
+	return true
+}
+
+func (a *jPluginsApp) printOutVersion(plugins plugins) (_ bool) {
+	if a.installedPlugins == nil {
+		return
+	}
+
+	pluginsList := make([]string, len(plugins))
+
+
+	iCount := 0
+	for name := range plugins {
+		pluginsList[iCount] = name
+		iCount++
+	}
+
+	sort.Strings(pluginsList)
+
+	for _, name := range pluginsList {
+		fmt.Printf("%s: %s\n", name, plugins[name].Version)
+	}
+	fmt.Println(iCount, "plugin(s)")
+	return true
+}

jplugins-app_list-installed.go

@@ -0,0 +1,36 @@
+package main
+
+import (
+	"fmt"
+)
+
+var build_branch, build_commit, build_date, build_tag string
+
+const (
+	// VERSION application
+	VERSION = "0.0.1"
+	// PRERELEASE = true if the version exposed is a pre-release
+	PRERELEASE = true
+	// AUTHOR is the project maintainer
+	AUTHOR = "Christophe Larsonneur <[email protected]>"
+)
+
+func (a *jPluginsApp) setVersion() {
+	var version string
+
+	if PRERELEASE {
+		version = " pre-release V" + VERSION
+	} else {
+		version = "forjj V" + VERSION
+	}
+
+	if build_branch != "master" {
+		version += fmt.Sprintf(" branch %s", build_branch)
+	}
+	if build_tag == "false" {
+		version += fmt.Sprintf(" patched - %s - %s", build_date, build_commit)
+	}
+
+	a.app.Version(version).Author(AUTHOR)
+
+}

jplugins-app_version.go

@@ -1,5 +1,20 @@
 package main
 
+import (
+	"os"
+
+	"github.com/alecthomas/kingpin"
+)
+
+// App is the application core struct
+var App jPluginsApp
+
 func main() {
-	
-}
+	App.init()
+
+	switch kingpin.MustParse(App.app.Parse(os.Args[1:])) {
+	// Register user
+	case App.listInstalled.FullCommand():
+		App.doListInstalled()
+	}
+}

main.go

@@ -0,0 +1,11 @@
+package main
+
+type pluginManifest struct {
+	Version        string `yaml:"Plugin-Version"`
+	Name           string `yaml:"Extension-Name"`
+	ShortName      string `yaml:"Short-Name"`
+	JenkinsVersion string `yaml:"Jenkins-Version"`
+	LongName       string `yaml:"Long-Name"`
+	Dependencies   string `yaml:"Plugin-Dependencies"`
+	Description    string `yaml:"Specification-Title"`
+}