Встраивание активов в Go

В этой статье я собираюсь показать вам, как встраивать активы в Go. В частности, я проведу вас через процесс, который я использовал для встраивания сценария оболочки в chef-runner, один из моих проектов Go с открытым исходным кодом. Моя цель — дать вам возможность применить эту полезную технику к вашим собственным проектам — используя правильные инструменты для работы и комбинируя их наилучшим образом. Давайте начнем!

Встречайте шеф-повара: самый быстрый способ запустить поваренные книги шеф-повара

Цель Chef -Runner — ускорить разработку и тестирование поваренных книг Chef . Первоначально я разработал инструмент как быструю альтернативу мучительно медленной vagrant provisionкоманде. С тех пор chef-runner развился и теперь может использоваться для быстрого предоставления не только локальных машин Vagrant, но и удаленных хостов, таких как экземпляры EC2.

Одна из вещей, которую может сделать chef-runner, — это установить Chef на компьютер перед его подготовкой. Это позволяет настроить серверы без поддержки, на которых ничего не установлено, кроме базовой операционной системы. Для этой функции chef-runner обычно загружал установщик Omnibus, более известный как install.shскрипт, в локальную папку, прежде чем копировать его на целевой компьютер, где он будет запущен для установки Chef.

Позже я решил немного изменить механизм. Вместо того, чтобы загружать скрипт инсталлятора из Интернета, я подумал, что было бы лучше встроить скрипт и сделать его частью исходного кода chef-runner. Это даст следующие преимущества:

• Простота. Код становится проще. Нет логики загрузки. Нет умного кеширования.
• Прозрачность . Всегда используйте один и тот же скрипт, который проверен в управлении версиями.
• Скорость . Нет необходимости снова загружать скрипт для каждого проекта.

В то же время я принял тот факт, что пользователи могут не получить немедленной выгоды от улучшений установщика, просто потому, что он обновляется очень редко.

шеф-бегун написан на го. Я знал, что в Go можно встроить активы, и это казалось идеальной возможностью познакомиться с инструментарием. Вот как я это сделал, используя комбинацию go-bindataи go generate.

Внедрение Активов, Сделанных Простым с go-bindata

go-bindata преобразует любой текстовый или двоичный файл в исходный код Go, что делает его идеальным инструментом для встраивания данных в программы Go. Вы можете использовать его, например, для встраивания ресурсов, таких как CSS, JavaScript и файлы изображений, в ваше веб-приложение. Результатом будет полностью автономный двоичный файл, который можно развернуть так же легко, как и любую другую программу Go.

Раньше я go-bindataдобавлял установщик Omnibus в качестве актива в пакет omnibus от chef-runner . Для этого все, что мне нужно было сделать, это загрузить скрипт установщика один раз, а затем вызвать go-bindataинструмент командной строки для генерации кода Go из него. Точные шаги заключаются в следующем:

# inside $GOPATH/src/github.com/mlafeldt/chef-runner
$ cd chef/omnibus/ 
$ mkdir assets 
$ curl https://www.chef.io/chef/install.sh > assets/install.sh 
$ go-bindata -pkg omnibus -o assets.go assets/

// chef/omnibus/omnibus.go

package omnibus

type Installer struct { 
    ChefVersion string 
    SandboxPath string 
    RootPath string 
    Sudo bool 
}

func (i Installer) writeOmnibusScript() error { 
    script := path.Join(i.SandboxPath, "install.sh") 
    log.Debugf("Writing Omnibus script to %s\n", script) 
    data, err := Asset("assets/install.sh") 
    if err != nil { 
        return err 
    } 
    return ioutil.WriteFile(script, []byte(data), 0644) 
}

// chef/omnibus/omnibus.go

package omnibus

//go:generate go-bindata -pkg $GOPACKAGE -o assets.go assets/

$ go generate -x ./chef/omnibus
go-bindata -pkg omnibus -o assets.go assets/