diff --git a/core/poller/.gitignore b/core/poller/.gitignore index f99dc2a2..72dc9b4d 100644 --- a/core/poller/.gitignore +++ b/core/poller/.gitignore @@ -7,6 +7,8 @@ /unifi-poller*.pkg /unifi-poller.macos /unifi-poller.linux +/unifi-poller.rb +*.sha256 /vendor .DS_Store *~ @@ -16,3 +18,4 @@ README README.html /md2roff /unifi-poller_manual.html +/homebrew-repo diff --git a/core/poller/.travis.yml b/core/poller/.travis.yml index 839da165..6e1df712 100644 --- a/core/poller/.travis.yml +++ b/core/poller/.travis.yml @@ -10,7 +10,7 @@ go: - 1.12.x before_install: - mkdir -p $GOPATH/bin - # This deploy is not used atm. + # This deploy key is not used atm. - openssl aes-256-cbc -K $encrypted_9f3147001275_key -iv $encrypted_9f3147001275_iv -in .github_deploy_key.enc -out github_deploy_key -d - chmod 600 github_deploy_key - eval $(ssh-agent -s) @@ -26,13 +26,19 @@ install: script: - rvm $brew_ruby do make release deploy: - provider: releases - api_key: - secure: GsvW0m+EnRELQMk8DjH63VXinqbwse4FJ4vNUslOE6CZ8PBXPrH0ZgaI7ic/uxRtm7CYj0sir4CZq62W5l6uhoXCCQfjOnmJspqnQcrFZ1xRdWktsNXaRwM6hlzaUThsJ/1PD9Psc66uKXBYTg0IlUz0yjZAZk7tCUE4libuj41z40ZKxUcbfcNvH4Njc9IpNB4QSA3ss+a9/6ZwBz4tHVamsGIrzaE0Zf99ItNBYvaOwhM2rC/NWIsFmwt8w4rIA2NIrkZgMDV+Z2Niqh4JRLAWCQNx/RjC5U52lG2yhqivUC3TromZ+q4O4alUltsyIzF2nVanLWgJmbeFo8uXT5A+gd3ovSkFLU9medXd9i4kap7kN/o5m9p5QZvrdEYHEmIU4ml5rjT2EQQVy5CtSmpiRAbhpEJIvA1wDtRq8rdz8IVfJXkHNjg2XdouNmMMWqa3OkEPw21+uxsqv4LscW/6ZjsavzL5SSdnBRU9n79EfGJE/tJLKiNumah/vLuJ5buNhgqmCdtX/Tg+DhQS1BOyYg4l4L8s9IIKZgFRwrOPsZnA/KsrWg4ZsjJ87cqKCaT/qs2EJx5odZcZWJYLBngeO8Tc6cQtLgJdieY2oEKo51Agq4rgikZDt21m6TY9/R5lPN0piwdpy3ZGKfv1ijXx74raMT03qskputzMCvc= - overwrite: true - skip_cleanup: true - file_glob: true - file: release/* - on: - repo: davidnewhall/unifi-poller - tags: true + - provider: releases + api_key: + secure: GsvW0m+EnRELQMk8DjH63VXinqbwse4FJ4vNUslOE6CZ8PBXPrH0ZgaI7ic/uxRtm7CYj0sir4CZq62W5l6uhoXCCQfjOnmJspqnQcrFZ1xRdWktsNXaRwM6hlzaUThsJ/1PD9Psc66uKXBYTg0IlUz0yjZAZk7tCUE4libuj41z40ZKxUcbfcNvH4Njc9IpNB4QSA3ss+a9/6ZwBz4tHVamsGIrzaE0Zf99ItNBYvaOwhM2rC/NWIsFmwt8w4rIA2NIrkZgMDV+Z2Niqh4JRLAWCQNx/RjC5U52lG2yhqivUC3TromZ+q4O4alUltsyIzF2nVanLWgJmbeFo8uXT5A+gd3ovSkFLU9medXd9i4kap7kN/o5m9p5QZvrdEYHEmIU4ml5rjT2EQQVy5CtSmpiRAbhpEJIvA1wDtRq8rdz8IVfJXkHNjg2XdouNmMMWqa3OkEPw21+uxsqv4LscW/6ZjsavzL5SSdnBRU9n79EfGJE/tJLKiNumah/vLuJ5buNhgqmCdtX/Tg+DhQS1BOyYg4l4L8s9IIKZgFRwrOPsZnA/KsrWg4ZsjJ87cqKCaT/qs2EJx5odZcZWJYLBngeO8Tc6cQtLgJdieY2oEKo51Agq4rgikZDt21m6TY9/R5lPN0piwdpy3ZGKfv1ijXx74raMT03qskputzMCvc= + overwrite: true + skip_cleanup: true + file_glob: true + file: release/* + on: + repo: davidnewhall/unifi-poller + tags: true + - provider: script + script: scripts/formula-deploy.sh ${TRAVIS_TAG} + on: + repo: davidnewhall/unifi-poller + tags: true +secure: "0yBdTabuF8LM8nQ8hSF1wjigQawal9N/v2NlR62oioMvzqWOy0zKo8R+mcfHK+pCByx0Ki/VWslms/WBKQnQvolGKY32UOg2cJvoVMoOemcwaezLK0kGZt8+O83ZQLr0CsiuzLQxJoqjiYf8ca6N2tjDFIowLPzSNPQR32mAP8cTe5fkxKyFAXgmA41BkzWMTx/V9R6udcX+Oofi8tpIZv1fyqSMNVlItHLxLFeP7F/r6OSM/Y87abAOt1U/ugPDufCL1MpmjRNhkL+NnHajSI30RsHFMv0c96hV3Va2g1VXrEVTB3F/0HhwBd9vwWwmiAGDMP/Nh7WfkQjHgHYCWVlbYgEdZj3rxeP9p14WEki3VavW2tZENjXoHpJswcT3UhB2m49p+pyV9NbzxZKeJDa2oniYBA9RfCrIURUIDI9Mk7vb+SVdcwx8JioiOebo568eRNHFI66KmQFrCGs+ZSuGFMk2ftaqhHSSctaD14EXzIurmWernw8xwmJAyiyBx6bKUIF969lBPlLVVCbl86ekNjm5xPxCaUM+Evugzo6nGsGckEUor85Ej54Q8qcxO/3m12F6gbHaEUUVK1splk+3dvDrSTZ6zJ+opxKkFph1MLjqQOIwqGU6DMMKy0JxMusjRg8n135LQQ/V05+Mzci4AF+kctidKfE42JDt5vA=" diff --git a/core/poller/Makefile b/core/poller/Makefile index c884c635..eb7f723f 100644 --- a/core/poller/Makefile +++ b/core/poller/Makefile @@ -1,22 +1,29 @@ +# This Makefile is written as generic as possible. +# Setting these variables and creating the necesarry paths in your github repo will make this file work. +# BINARY:=unifi-poller -URL=https://github.com/davidnewhall/unifi-poller -MAINT="David Newhall II " -DESC="This daemon polls a Unifi controller at a short interval and stores the collected metric data in an Influx Database." +URL:=https://github.com/davidnewhall/$(BINARY) +MAINT=David Newhall II +DESC=This daemon polls a Unifi controller at a short interval and stores the collected metric data in an Influx Database. PACKAGE:=./cmd/$(BINARY) ifeq ($(VERSION),) VERSION:=$(shell git tag -l --merged | tail -n1 | tr -d v||echo development) endif ITERATION:=$(shell git rev-list --count HEAD||echo 0) +OSX_PKG_PREFIX=com.github.davidnewhall +GOLANGCI_LINT_ARGS=--enable-all -D gochecknoglobals + +RPMVERSION:=$(shell echo $(VERSION) | tr -- - _) all: man build # Prepare a release. Called in Travis CI. -release: clean test $(BINARY)-$(VERSION)-$(ITERATION).x86_64.rpm $(BINARY)_$(VERSION)-$(ITERATION)_amd64.deb $(BINARY)-$(VERSION).pkg +release: clean test $(BINARY)-$(RPMVERSION)-$(ITERATION).x86_64.rpm $(BINARY)_$(VERSION)-$(ITERATION)_amd64.deb $(BINARY)-$(VERSION).pkg # Prepareing a release! mkdir -p release gzip -9 $(BINARY).linux gzip -9 $(BINARY).macos - mv $(BINARY)-$(VERSION)-$(ITERATION).x86_64.rpm $(BINARY)_$(VERSION)-$(ITERATION)_amd64.deb \ + mv $(BINARY)-$(RPMVERSION)-$(ITERATION).x86_64.rpm $(BINARY)_$(VERSION)-$(ITERATION)_amd64.deb \ $(BINARY)-$(VERSION).pkg $(BINARY).macos.gz $(BINARY).linux.gz release/ # Generating File Hashes openssl dgst -sha256 release/* | tee release/$(BINARY)_checksums_$(VERSION)-$(ITERATION).txt @@ -24,8 +31,8 @@ release: clean test $(BINARY)-$(VERSION)-$(ITERATION).x86_64.rpm $(BINARY)_$(VER # Delete all build assets. clean: # Cleaning up. - rm -f $(BINARY){.macos,.linux,.1,}{,.gz} - rm -f $(BINARY){_,-}*.{deb,rpm,pkg} md2roff + rm -f $(BINARY){.macos,.linux,.1,}{,.gz} $(BINARY).rb + rm -f $(BINARY){_,-}*.{deb,rpm,pkg} md2roff v$(VERSION).tar.gz.sha256 rm -f cmd/$(BINARY)/README{,.html} README{,.html} ./$(BINARY)_manual.html rm -rf package_build_* release @@ -39,7 +46,7 @@ md2roff: man: $(BINARY).1.gz $(BINARY).1.gz: md2roff # Building man page. Build dependency first: md2roff - ./md2roff --manual $(BINARY) --version $(VERSION) --date "$$(date)" cmd/unifi-poller/README.md + ./md2roff --manual $(BINARY) --version $(VERSION) --date "$$(date)" cmd/$(BINARY)/README.md gzip -9nc cmd/$(BINARY)/README > $(BINARY).1.gz mv cmd/$(BINARY)/README.html $(BINARY)_manual.html @@ -48,7 +55,6 @@ readme: README.html README.html: md2roff # This turns README.md into README.html ./md2roff --manual $(BINARY) --version $(VERSION) --date "$$(date)" README.md - @rm -f README # Delete useless "man" formatted version. # Binaries @@ -68,20 +74,20 @@ $(BINARY).macos: # Packages -rpm: clean $(BINARY)-$(VERSION)-$(ITERATION).x86_64.rpm -$(BINARY)-$(VERSION)-$(ITERATION).x86_64.rpm: check_fpm package_build_linux - @echo "Building 'rpm' package for $(BINARY) version '$(VERSION)-$(ITERATION)'." +rpm: clean $(BINARY)-$(RPMVERSION)-$(ITERATION).x86_64.rpm +$(BINARY)-$(RPMVERSION)-$(ITERATION).x86_64.rpm: check_fpm package_build_linux + @echo "Building 'rpm' package for $(BINARY) version '$(RPMVERSION)-$(ITERATION)'." fpm -s dir -t rpm \ --name $(BINARY) \ --rpm-os linux \ - --version $(VERSION) \ + --version $(RPMVERSION) \ --iteration $(ITERATION) \ --after-install scripts/after-install.sh \ --before-remove scripts/before-remove.sh \ --license MIT \ --url $(URL) \ - --maintainer $(MAINT) \ - --description $(DESC) \ + --maintainer "$(MAINT)" \ + --description "$(DESC)" \ --chdir package_build_linux deb: clean $(BINARY)_$(VERSION)-$(ITERATION)_amd64.deb @@ -95,8 +101,8 @@ $(BINARY)_$(VERSION)-$(ITERATION)_amd64.deb: check_fpm package_build_linux --before-remove scripts/before-remove.sh \ --license MIT \ --url $(URL) \ - --maintainer $(MAINT) \ - --description $(DESC) \ + --maintainer "$(MAINT)" \ + --description "$(DESC)" \ --chdir package_build_linux osxpkg: clean $(BINARY)-$(VERSION).pkg @@ -107,18 +113,18 @@ $(BINARY)-$(VERSION).pkg: check_fpm package_build_osx --version $(VERSION) \ --iteration $(ITERATION) \ --after-install scripts/after-install.sh \ - --osxpkg-identifier-prefix com.github.davidnewhall \ + --osxpkg-identifier-prefix $(OSX_PKG_PREFIX) \ --license MIT \ --url $(URL) \ - --maintainer $(MAINT) \ - --description $(DESC) \ + --maintainer "$(MAINT)" \ + --description "$(DESC)" \ --chdir package_build_osx # OSX packages use /usr/local because Apple doesn't allow writing many other places. package_build_osx: readme man macos # Building package environment for macOS. mkdir -p $@/usr/local/bin $@/usr/local/etc/$(BINARY) $@/Library/LaunchAgents - mkdir -p $@/usr/local/share/man/man1 $@/usr/local/share/doc/$(BINARY)/examples $@/usr/local/var/log/unifi-poller + mkdir -p $@/usr/local/share/man/man1 $@/usr/local/share/doc/$(BINARY)/examples $@/usr/local/var/log/$(BINARY) # Copying the binary, config file and man page into the env. cp $(BINARY).macos $@/usr/local/bin/$(BINARY) cp *.1.gz $@/usr/local/share/man/man1 @@ -126,7 +132,7 @@ package_build_osx: readme man macos cp *.html examples/{*dash.json,up.conf.example} $@/usr/local/share/doc/$(BINARY)/ # These go to their own folder so the img src in the html pages continue to work. cp examples/*.png $@/usr/local/share/doc/$(BINARY)/examples - cp init/launchd/com.github.davidnewhall.$(BINARY).plist $@/Library/LaunchAgents/ + cp init/launchd/$(OSX_PKG_PREFIX).$(BINARY).plist $@/Library/LaunchAgents/ # Build an environment that can be packaged for linux. package_build_linux: readme man linux @@ -146,6 +152,15 @@ package_build_linux: readme man linux check_fpm: @fpm --version > /dev/null || (echo "FPM missing. Install FPM: https://fpm.readthedocs.io/en/latest/installing.html" && false) +# This builds a Homebrew formula file that can be used to install this app from source. +formula: $(BINARY).rb +v$(VERSION).tar.gz.sha256: + # Calculate the SHA from the Github source file. + curl -sL $(URL)/archive/v$(VERSION).tar.gz | openssl dgst -sha256 | tee v$(VERSION).tar.gz.sha256 +$(BINARY).rb: v$(VERSION).tar.gz.sha256 + # Creating formula from template using sed. + sed "s/{{Version}}/$(VERSION)/g;s/{{SHA256}}/$$( You must run make uninstall as root on Linux. Recommend not running as root on macOS." [ -x /bin/systemctl ] && /bin/systemctl disable $(BINARY) || true [ -x /bin/systemctl ] && /bin/systemctl stop $(BINARY) || true - [ -x /bin/launchctl ] && [ -f ~/Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist ] \ - && /bin/launchctl unload ~/Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist || true - [ -x /bin/launchctl ] && [ -f /Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist ] \ - && /bin/launchctl unload /Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist || true + [ -x /bin/launchctl ] && [ -f ~/Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist ] \ + && /bin/launchctl unload ~/Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist || true + [ -x /bin/launchctl ] && [ -f /Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist ] \ + && /bin/launchctl unload /Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist || true rm -rf /usr/local/{etc,bin,share/doc}/$(BINARY) - rm -f ~/Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist - rm -f /Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist || true + rm -f ~/Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist + rm -f /Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist || true rm -f /etc/systemd/system/$(BINARY).service /usr/local/share/man/man1/$(BINARY).1.gz [ -x /bin/systemctl ] && /bin/systemctl --system daemon-reload || true - @[ -f /Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist ] && echo " ==> Unload and delete this file manually:" && echo " sudo launchctl unload /Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist" && echo " sudo rm -f /Library/LaunchAgents/com.github.davidnewhall.$(BINARY).plist" || true + @[ -f /Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist ] && echo " ==> Unload and delete this file manually:" && echo " sudo launchctl unload /Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist" && echo " sudo rm -f /Library/LaunchAgents/$(OSX_PKG_PREFIX).$(BINARY).plist" || true # Don't run this unless you're ready to debug untested vendored dependencies. deps: diff --git a/core/poller/scripts/formula-deploy.sh b/core/poller/scripts/formula-deploy.sh new file mode 100755 index 00000000..d6d51dc3 --- /dev/null +++ b/core/poller/scripts/formula-deploy.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +# Deploys a new unifi-poller.rb formula file to golift/homebrew-tap. + +make unifi-poller.rb +VERSION=$(grep -E '^\s*version\s*"' unifi-poller.rb | cut -d\" -f 2) + +git config user.name "unifi-poller-bot" +git config user.email "unifi@poller.bot" + +rm -rf homebrew-repo +git clone https://$GITHUB_API_KEY@github.com/golift/homebrew-repo.git + +cp unifi-poller.rb homebrew-repo/Formula +pushd homebrew-repo +echo "Showing diff:" +git diff +git commit -m "Update unifi-poller on Release: v${VERSION}" Formula/unifi-poller.rb +git push +popd diff --git a/core/poller/templates/README.md b/core/poller/templates/README.md new file mode 100644 index 00000000..6d321dea --- /dev/null +++ b/core/poller/templates/README.md @@ -0,0 +1,2 @@ +This folder contains build templates. +Used to create packages and homebrew formula. diff --git a/core/poller/templates/unifi-poller.rb.tmpl b/core/poller/templates/unifi-poller.rb.tmpl new file mode 100644 index 00000000..c086d8c8 --- /dev/null +++ b/core/poller/templates/unifi-poller.rb.tmpl @@ -0,0 +1,31 @@ +# Homebrew Formula, still under development - June 2019 +require "language/go" + +class UnifiPoller < Formula + version "{{Version}}" + sha256 "{{SHA256}}" + url "{{URL}}/archive/v#{version}.tar.gz" + head "{{URL}}" + desc "{{Desc}}" + homepage "{{URL}}" + + depends_on "go" => :build + depends_on "dep" + + def install + ENV["GOPATH"] = buildpath + + bin_path = buildpath/"src/github.com/davidnewhall/unifi-poller" + # Copy all files from their current location (GOPATH root) + # to $GOPATH/src/github.com/davidnewhall/unifi-poller + bin_path.install Dir["*"] + cd bin_path do + system "dep", "ensure" + system "make", "install", "VERSION=#{version}", "PREFIX=#{prefix}" + end + end + + test do + assert_match "unifi-poller v#{version}", shell_output("#{bin}/unifi-poller -v 2>&1", 2) + end +end