sous-chefs / atom

Development repository for the atom cookbook

sous-chefs.org website

The website is created using the static site generator, Hugo.

The live website is hosted on GitHub pages on the gh-pages branch. Netlify is used to preview changes on branches.

Development

1. Install Hugo for your platform according to the instructions

2. Create a feature branch to work on based off of main

3. Clone the website code and start the development server. This will run a local hugo server that watches for changes to the source files. There will be a section in the output showing which port the site is served on (typically http://localhost:1313):

   git clone [email protected]:sous-chefs/website
   cd website
   git checkout -b my-feature-branch
   hugo server -ws .

4. Commit your changes, push the branch to the remote and open a Pull Request.

   git push --set-upstream origin my-feature-branch

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

atom's Issues

Use newer windows test images.

:person_frowning: Problem Statement

We have tests using Matt Wrock's old windows images. We should use the new images created by tas50 to test the cookbook on a windows server.

Run latest cookstyle

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

Chef have released updated cookstyle rules, we should therefore run the auto fix against the cookbook

1. Ensure you are on the latest stable chef-workstation
2. Run cookstyle -a

Issue sprouted from sous-chefs/meta/issues/111. If not applicable then issue should be closed.

include_recipe 'atom' does not install Atom on Ubuntu 20.04

🗣️ Foreword

Am brand new to Chef. Apologies if I'm missing something trivial.

👻 Brief Description

include_recipe 'atom' leads to errors since it looks like there is no Atom release candidate for Ubuntu 20.04 Focal Fossa.

Summary:

• STDERR: E: The repository 'http://ppa.launchpad.net/webupd8team/atom/ubuntu focal Release' does not have a Release file.
• No candidate version available for atom
• Error executing action 'install' on resource 'apt_package[atom]'

Full trace:

        virtualbox-iso:       Reading package lists...
        virtualbox-iso:       STDERR: E: The repository 'http://ppa.launchpad.net/webupd8team/atom/ubuntu focal Release' does not have a Release file.
        virtualbox-iso:       ---- End output of ["apt-get", "-q", "update"] ----
        virtualbox-iso:       Ran ["apt-get", "-q", "update"] returned 100
        virtualbox-iso:
        virtualbox-iso:       Resource Declaration:
        virtualbox-iso:       ---------------------
        virtualbox-iso:       # In /opt/chef/embedded/lib/ruby/gems/2.5.0/gems/chef-14.15.6/lib/chef/provider/apt_repository.rb
        virtualbox-iso: 
        virtualbox-iso:        58:         declare_resource(:apt_update, new_resource.name) do
        virtualbox-iso:        59:           ignore_failure true
        virtualbox-iso:        60:           action :nothing
        virtualbox-iso:        61:         end
        virtualbox-iso:        62:
        virtualbox-iso: 
        virtualbox-iso:       Compiled Resource:
        virtualbox-iso:       ------------------
        virtualbox-iso:       # Declared in /opt/chef/embedded/lib/ruby/gems/2.5.0/gems/chef-14.15.6/lib/chef/provider/apt_repository.rb:58:in `block in <class:AptRepository>'
        virtualbox-iso: 
        virtualbox-iso:       apt_update("atom-ppa") do
        virtualbox-iso:         action [:nothing]
        virtualbox-iso:         default_guard_interpreter :default
        virtualbox-iso:         declared_type :apt_update
        virtualbox-iso:         cookbook_name "atom"
        virtualbox-iso:         ignore_failure true
        virtualbox-iso:       end
        virtualbox-iso:       Get:15 http://archive.ubuntu.com/ubuntu focal/main DEP-11 64x64 Icons [163 kB]
        virtualbox-iso:       Get:16 http://archive.ubuntu.com/ubuntu focal/universe amd64 DEP-11 Metadata [3603 kB]
        virtualbox-iso:       Get:17 http://archive.ubuntu.com/ubuntu focal/universe DEP-11 48x48 Icons [3016 kB]
        virtualbox-iso:       Get:18 http://archive.ubuntu.com/ubuntu focal/universe DEP-11 64x64 Icons [7794 kB]
        virtualbox-iso:       Get:19 http://archive.ubuntu.com/ubuntu focal/multiverse amd64 DEP-11 Metadata [48.4 kB]
        virtualbox-iso:       Get:20 http://archive.ubuntu.com/ubuntu focal/multiverse DEP-11 48x48 Icons [23.1 kB]
        virtualbox-iso:       Get:21 http://archive.ubuntu.com/ubuntu focal/multiverse DEP-11 64x64 Icons [192 kB]
        virtualbox-iso:       Get:22 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 DEP-11 Metadata [264 kB]
        virtualbox-iso:       Get:23 http://archive.ubuntu.com/ubuntu focal-updates/main DEP-11 48x48 Icons [55.6 kB]
        virtualbox-iso:       Get:24 http://archive.ubuntu.com/ubuntu focal-updates/main DEP-11 64x64 Icons [87.9 kB]
        virtualbox-iso:       Get:25 http://archive.ubuntu.com/ubuntu focal-updates/universe amd64 DEP-11 Metadata [303 kB]
        virtualbox-iso:       Get:26 http://archive.ubuntu.com/ubuntu focal-updates/universe DEP-11 48x48 Icons [200 kB]
        virtualbox-iso:       Get:27 http://archive.ubuntu.com/ubuntu focal-updates/universe DEP-11 64x64 Icons [356 kB]
        virtualbox-iso:       Get:28 http://archive.ubuntu.com/ubuntu focal-updates/multiverse amd64 DEP-11 Metadata [2468 B]
        virtualbox-iso:       Get:29 http://archive.ubuntu.com/ubuntu focal-updates/multiverse DEP-11 48x48 Icons [29 B]
        virtualbox-iso:       Get:30 http://archive.ubuntu.com/ubuntu focal-updates/multiverse DEP-11 64x64 Icons [2638 B]
        virtualbox-iso:       Get:31 http://archive.ubuntu.com/ubuntu focal-backports/universe amd64 DEP-11 Metadata [1768 B]
        virtualbox-iso:       Get:32 http://archive.ubuntu.com/ubuntu focal-backports/universe DEP-11 48x48 Icons [2809 B]
        virtualbox-iso:       Get:33 http://archive.ubuntu.com/ubuntu focal-backports/universe DEP-11 64x64 Icons [3944 B]
        virtualbox-iso:       Reading package lists...
        virtualbox-iso:       STDERR: E: The repository 'http://ppa.launchpad.net/webupd8team/atom/ubuntu focal Release' does not have a Release file.
        virtualbox-iso:       ---- End output of ["apt-get", "-q", "update"] ----
        virtualbox-iso:       Ran ["apt-get", "-q", "update"] returned 100
        virtualbox-iso:
        virtualbox-iso:       Resource Declaration:
        virtualbox-iso:       ---------------------
        virtualbox-iso:       # In /opt/chef/embedded/lib/ruby/gems/2.5.0/gems/chef-14.15.6/lib/chef/provider/apt_repository.rb
        virtualbox-iso: 
        virtualbox-iso:        58:         declare_resource(:apt_update, new_resource.name) do
        virtualbox-iso:        59:           ignore_failure true
        virtualbox-iso:        60:           action :nothing
        virtualbox-iso:        61:         end
        virtualbox-iso:        62:
        virtualbox-iso: 
        virtualbox-iso:       Compiled Resource:
        virtualbox-iso:       ------------------
        virtualbox-iso:       # Declared in /opt/chef/embedded/lib/ruby/gems/2.5.0/gems/chef-14.15.6/lib/chef/provider/apt_repository.rb:58:in `block in <class:AptRepository>'
        virtualbox-iso: 
        virtualbox-iso:       apt_update("atom-ppa") do
        virtualbox-iso:         action [:nothing]
        virtualbox-iso:         default_guard_interpreter :default
        virtualbox-iso:         declared_type :apt_update
        virtualbox-iso:         cookbook_name "atom"
        virtualbox-iso:         ignore_failure true
        virtualbox-iso:       end
        virtualbox-iso: 
        virtualbox-iso:       System Info:
        virtualbox-iso:       ------------
        virtualbox-iso:       chef_version=14.15.6
        virtualbox-iso:       platform=ubuntu
        virtualbox-iso:       platform_version=20.04
        virtualbox-iso:       ruby=ruby 2.5.8p224 (2020-03-31 revision 67882) [x86_64-linux]
        virtualbox-iso:       program_name=/usr/bin/chef-client
        virtualbox-iso:       executable=/opt/chef/bin/chef-client
        virtualbox-iso:
        virtualbox-iso: 
        virtualbox-iso:   * apt_package[atom] action install
        virtualbox-iso:     * No candidate version available for atom
        virtualbox-iso:     ================================================================================
        virtualbox-iso:     Error executing action `install` on resource 'apt_package[atom]'
        virtualbox-iso:     ================================================================================
        virtualbox-iso:
        virtualbox-iso:     Chef::Exceptions::Package
        virtualbox-iso:     -------------------------
        virtualbox-iso:     No candidate version available for atom
        virtualbox-iso:
        virtualbox-iso:     Resource Declaration:
        virtualbox-iso:     ---------------------
        virtualbox-iso:     # In /var/chef/cache/cookbooks/atom/recipes/debian.rb
        virtualbox-iso: 
        virtualbox-iso:      23: package 'atom'
        virtualbox-iso: 
        virtualbox-iso:     Compiled Resource:
        virtualbox-iso:     ------------------
        virtualbox-iso:     # Declared in /var/chef/cache/cookbooks/atom/recipes/debian.rb:23:in `from_file'
        virtualbox-iso: 
        virtualbox-iso:     apt_package("atom") do
        virtualbox-iso:       package_name "atom"
        virtualbox-iso:       action [:install]
        virtualbox-iso:       default_guard_interpreter :default
        virtualbox-iso:       declared_type :package
        virtualbox-iso:       cookbook_name "atom"
        virtualbox-iso:       recipe_name "debian"
        virtualbox-iso:     end

No candidate version available for atom on Ubuntu 20.04

🥞 Cookbook version

0.4.0

👩‍🍳 Chef-Infra Version

chef_version=14.15.6

🎩 Platform details

platform=ubuntu
platform_version=20.04
ruby=ruby 2.5.8p224 (2020-03-31 revision 67882) [x86_64-linux]

Steps To Reproduce

Just try include_recipe 'atom' on Ubuntu 20.04

🚓 Expected behavior

There are working instructions here using apt and packagecloud instead of webupd8team. Given a working solution exists (tested, it works for me) where I can install Atom for Ubuntu 20.04 manually I'd expect this recipe to have some support somehow to install Atom on Ubuntu 20.04.

➕ Additional context

Likely just a sidenote but using the packagecloud recipe to install Atom has problems of its own

I did also try manually changing the debian recipe to this just so I can have something working:

apt_repository 'atom-ppa' do
  uri 'ppa:webupd8team/atom'
  distribution  'bionic'
end

This does lead to an installation and at first I thought things were working but this is the error message I get when I try to run Atom:

Looks like a known problem solved here. Once again solved using packagecloud. I have been trying and failing to modify the source further to source it from packagecloud. I tried modifying the debian recipe further to:

apt_repository 'atom-ppa' do
  uri 'https://packagecloud.io/AtomEditor/atom/any/'
  distribution 'bionic'
  arch 'amd64'
  keyserver 'packagecloud.io/AtomEditor/atom/gpgkey'
end

But this leads to:

• STDERR: E: Malformed entry 1 in list file /etc/apt/sources.list.d/atom-ppa.list (Component)
• Error executing action run on resource 'execute[apt-cache gencaches]'
• Error executing action run on resource 'execute[apt-get -q update]'
• Error executing action update on resource 'apt_update[atom-ppa]'
• Error executing action install on resource 'apt_package[atom]'

Changelog does not pass markdownlint

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

The changelog (and likely other .md files) do not pass markdown lint, these files should be brought in line with markdownlint in order for the CI/CD pipeline to work

🥞 Cookbook version

Master

Steps To Reproduce

Steps to reproduce the behavior:

Install markdownlint
run markdown lint
see failures

🚓 Expected behavior

markdown lint passes

Add a TESTING.md file

:person_frowning: Problem Statement

Get the code quality metric in supermarket to 100%.
Document the testing expectations.

undefined method `execute' for #<Chef::Provider::AtomApm:0x00000002f1a570>

..oh, and while trying to use the atom_apm LWRP with Chef 12.0.1 I got this:

==> dev-box: Recipe: atom::default
==> dev-box:   * apt_repository[atom-ppa] action add
==> dev-box:  (up to date)
==> dev-box: Recipe: dev-box::atom
==> dev-box:   * apt_package[atom] action install
==> dev-box:  (up to date)
==> dev-box:   * atom_apm[minimap] action install
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box: ================================================================================
==> dev-box:     Error executing action `install` on resource 'atom_apm[minimap]'
==> dev-box:
==> dev-box: ================================================================================
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box:     NoMethodError
==> dev-box:     -------------
==> dev-box:
==> dev-box:     undefined method `execute' for #<Chef::Provider::AtomApm:0x00000002f1a570>
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box: Cookbook Trace:
==> dev-box:
==> dev-box: ---------------
==> dev-box:     /tmp/vagrant-chef-3/chef-solo-1/cookbooks/atom/libraries/apm.rb:61:in `action_install'
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box:
==> dev-box: Resource Declaration:
==> dev-box:
==> dev-box: ---------------------
==> dev-box:
==> dev-box: # In /tmp/vagrant-chef-3/chef-solo-1/cookbooks/dev-box/recipes/atom.rb
==> dev-box:
==> dev-box:
==> dev-box:  11: atom_apm "minimap"
==> dev-box:
==> dev-box:  12:
==> dev-box:
==> dev-box:

Might it be an incompatibility with Chef 12?

Chef 17 deprecation warnings

🗣️ Foreword

Thank for taking the time to fill this feature request fully. Without it we may not be able to , and the issue may be closed without resolution.

:person_frowning: Problem Statement

Chef 17 compatibility, change the default branch to main

❔ Possible Solution

A clear and concise description of what you want to happen.

⤴️ Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

➕ Additional context

Add any other context about the problem here. e.g. related issues or existing pull requests.

Active?

Hey there!

Dan from Sous Chefs here, looks like you have a few open pull requests.

We aim to foster cookbooks and keep them healthy. We reduce the "bus factor" or the contributor busy factor by encouraging more people to contribute and own cookbooks.

Would you consider migrating this to Sous Chefs? You can still maintain it going forward.

Kind Regards,
Dan

Dangerfile should use failure instead of fail

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

On the repo, ensure that Dangerfile matches https://github.com/sous-chefs/repo-management/blob/master/Dangerfile

Issue sprouted from sous-chefs/meta/issues/110. If not applicable then issue should be closed.

Update Changelog

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

Update all CHANGELOGs to follow standard defined at https://keepachangelog.com/

Issue sprouted from sous-chefs/meta/issues/101. If not applicable then issue should be closed.

atom_apm resource don't install packages

Hi,

I am using:

default['atom']['packages'] = %w(language-chef linter-chefstyle)
node['atom']['packages'].each do |pkg|
atom_apm "#{pkg}"
end

and the result is this:

• atom_apm[language-chef] action install (up to date)
• atom_apm[linter-chefstyle] action install (up to date)

But, it seems the packages are not installed at all.

• Windows 7 SP1 with latest updates
• chefdk 2.0.28
• PowerShell 5.1
• Microsoft Visual C++ 2010 x64 and x86

Remove .rubocop.yml with Dangerfile

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

If the only thing in the .rubocop/yml is Dangerfile
Run the latest cookstyle
Remove .rubpopo.yml

Issue sprouted from sous-chefs/meta/issues/108. If not applicable then issue should be closed.

Why Docker?

I'm starting to refactor this cookbook, and noticed you used kitchen-docker. Any reason not to use straight Vagrant/VirtualBox, or kitchen-ec2? Docker adds more complexity to developing this cookbook on a Mac or Windows laptop.

Windows installation fails when chef-client is running as a service

Atom fails to install on Windows when chef-client is running as a service. This was tested on Windows Server 2012R2 but other Windows versions may be similarly affected.

This occurs due to Atom issue 5109: Path too long exception on Windows install as the default installation folder becomes C:\Windows\SysWOW64\config\systemprofile\AppData\Local\atom which is too long once the contents of the archive are extracted here.

This issue could also be replicated by running chef-client as a user with a very long username.

The log file during the installation process is available at C:\Windows\SysWOW64\config\systemprofile\AppData\Local\SquirrelTemp\SquirrelSetup.log.
and an excerpt from the logs is provided below:

2016-05-03 11:47:32> Program: Starting Squirrel Updater: --install . --Machine
2016-05-03 11:47:32> Program: Starting install, writing to C:\Windows\system32\config\systemprofile\AppData\Local\SquirrelTemp
2016-05-03 11:47:32> Program: About to install to: C:\Windows\SysWOW64\config\systemprofile\AppData\Local\atom
2016-05-03 11:47:32> CheckForUpdateImpl: Failed to load local releases, starting from scratch: System.IO.DirectoryNotFoundException: Could not find a part of the path 'C:\Windows\SysWOW64\config\systemprofile\AppData\Local\atom\packages\RELEASES'.
   at System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
   at System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
   at System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share)
   at Squirrel.Utility.LoadLocalReleases(String localReleaseFile)
   at Squirrel.UpdateManager.CheckForUpdateImpl.<CheckForUpdate>d__3f.MoveNext()
2016-05-03 11:47:32> CheckForUpdateImpl: Reading RELEASES file from C:\Windows\system32\config\systemprofile\AppData\Local\SquirrelTemp
2016-05-03 11:47:32> CheckForUpdateImpl: First run or local directory is corrupt, starting from scratch
2016-05-03 11:47:33> ApplyReleasesImpl: Writing files to app directory: C:\Windows\SysWOW64\config\systemprofile\AppData\Local\atom\app-1.7.3
2016-05-03 11:47:45> IEnableLogger: Failed to install package to app dir: System.IO.PathTooLongException: The specified path, file name, or both are too long. The fully qualified file name must be less than 260 characters, and the directory name must be less than 248 characters.
   at System.IO.PathHelper.GetFullPathName()
   at System.IO.Path.NormalizePath(String path, Boolean fullCheck, Int32 maxPathLength, Boolean expandShortPaths)
   at System.IO.Path.GetFullPathInternal(String path)
   at System.IO.Path.GetFullPath(String path)
   at ICSharpCode.SharpZipLib.Zip.FastZip.ExtractEntry(ZipEntry entry)
   at ICSharpCode.SharpZipLib.Zip.FastZip.ExtractZip(Stream inputStream, String targetDirectory, Overwrite overwrite, ConfirmOverwriteDelegate confirmDelegate, String fileFilter, String directoryFilter, Boolean restoreDateTime, Boolean isStreamOwner)
   at Squirrel.UpdateManager.ApplyReleasesImpl.<>c__DisplayClassb4.<<installPackageToAppDir>b__ad>d__bd.MoveNext()
--- End of stack trace from previous location where exception was thrown ---
   at System.Runtime.CompilerServices.TaskAwaiter.ThrowForNonSuccess(Task task)
   at System.Runtime.CompilerServices.TaskAwaiter.HandleNonSuccessAndDebuggerNotification(Task task)
   at Squirrel.Utility.<LogIfThrows>d__50`1.MoveNext()

atom - Chef 17 compatability

Update builds to be parallel

🗣️ Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

👻 Brief Description

As part of our build process we should build each possible operating system separately

1. Ensure you have dokken setup and working:
2. dokken: aliased to KITCHEN_LOCAL_YAML=kitchen.dokken.yml kitchen
3. run dokken list, you should see a list of builds with dokken as the provider
4. download: https://github.com/sous-chefs/repo-management/blob/master/scripts/circleci_maker.rb and make this executable
5. run: dokken list -j | ./circleci_maker.rb > .circleci/config.yml

Issue sprouted from sous-chefs/meta/issues/112. If not applicable then issue should be closed.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/ci.yml

• sous-chefs/.github 3.1.1
• actions/checkout v4
• actionshub/chef-install 3.0.0
• actionshub/test-kitchen 3.0.0

.github/workflows/stale.yml

• actions/stale v9

---

• Check this box to trigger a request for Renovate to run again on this repository

Does not install on Ubuntu?

Do I get it right that for Ubuntu / Debian only the PPA repo is added, but atom is not actually being installed?

Because right now I'm doing this:

# sets up ppa launchpad repo
include_recipe "atom"

# install atom
package "atom" do
  action :install
end

# install plugins
atom_apm "minimap"

Just wondering because the README says "installs / configures atom.io" and for windows it looks like it's actually being installed at version node[:atom][:version]...