Add homebrew_bundle module #46401

danieljaouen · 2018-10-02T15:45:40Z

SUMMARY

Adds the homebrew_bundle module.

ISSUE TYPE

New Module Pull Request

COMPONENT NAME

homebrew_bundle

ANSIBLE VERSION

± ansible --version
ansible 2.8.0.dev0 (homebrew_bundle 90b48de229) last updated 2018/10/02 11:28:46 (GMT -400)
  config file = /Users/dan/.ansible.cfg
  configured module search path = ['/Users/dan/src/ansible/library']
  ansible python module location = /Users/dan/src/ansible/lib/ansible
  executable location = /Users/dan/src/ansible/bin/ansible
  python version = 3.6.3 (default, Oct 21 2017, 11:37:52) [GCC 4.2.1 Compatible Apple LLVM 8.0.0 (clang-800.0.42.1)]

ADDITIONAL INFORMATION

N/A

danieljaouen · 2018-10-02T16:05:43Z

This is failing with E312: no RETURN provided. What exactly do I need to provide here?

ansibot · 2018-10-02T16:27:50Z

@AnderEnder @DJMuggs @JoergFiedler @KimNorgaard @L2G @albertomurillo @alxgu @andrew-d @andytom @barnabycourt @berenddeboer @berenddeschouwer @brian-brazil @brontitall @dermute @dinoocch @eest @enriclluelles @evgkrsk @FlossWare @giovannisciortino @hacosta @ignatenkobrain @indrajitr @jasperla @JayKayy @jcftang @jirutka @jtyr @jvantuyl @kahowell @kustodian @matze @mavit @melodous @mgwilliams @oolongbrothers @pmakowski @robinro @sashka @scathatheworm @skinp @sysadmind @szinck @tdtrask @the-maldridge @troy2914 @vaygr @verm666 @vincentvdk @vritant @wltjr

As a maintainer of a module in the same namespace this new module has been submitted to, your vote counts for shipits. Please review this module and add shipit if you would like to see it merged.

click here for bot help

danieljaouen · 2018-10-02T19:32:14Z

Still curious about the RETURN string, as I’d like to populate it with valid info instead of a blank comment.

_{Sent with GitHawk}

jborean93 · 2018-10-04T00:54:42Z

@danieljaouen it doesn't look like you are returning anything outside of the defaults like changed so having an empty RETURN string is fine. If you are wanting to return specific values then that needs to be done in the module code and documented as such. Some background info on return values

If you have further questions around this, I highly recommend you post a question on the mailing list or on IRC;

IRC: #ansible-devel on irc.freenode.net
mailing list: https://groups.google.com/forum/#!forum/ansible-devel

danieljaouen · 2018-10-04T04:23:24Z

@jborean93 Thanks for the info! I just wanted to make sure I wasn't skimming on the documentation for the module.

maxamillion · 2018-11-02T21:34:06Z

@mattclay ping - how would one go about writing macOS integration tests to exercise this functionality? Thanks!

mattclay · 2018-11-02T23:05:01Z

@maxamillion Creating an integration test for macOS isn't much different than any other integration test. The test should be named after the module being tested, as usual.

The test can use available facts to determine if tests need to be skipped due to the platform running the tests. As an optimization it should have entries to skip some platforms in the aliases file for the test:

skip/rhel
skip/freebsd

It may also help to take a look at some of the logic used for macOS when dealing with brew:

ansible/test/integration/targets/archive/tasks/main.yml

Lines 43 to 60 in f2f743a

    
           - name: Install prerequisites for backports.lzma when using python2 (OSX) 
        
             block: 
        
               - name: Find brew binary 
        
                 command: which brew 
        
                 register: brew_which 
        
               - name: Get owner of brew binary 
        
                 stat: path="{{ brew_which.stdout }}" 
        
                 register: brew_stat 
        
               - name: "Install package" 
        
                 homebrew: 
        
                   name: xz 
        
                   state: present 
        
                   update_homebrew: no 
        
                 become: yes 
        
                 become_user: "{{ brew_stat.stat.pw_name }}" 
        
             when: 
        
               - ansible_python_version.split('.')[0] == '2' 
        
               - ansible_os_family == 'Darwin'

maxamillion · 2018-11-06T16:11:24Z

@danieljaouen if you don't mind, can you add some integration tests to exercise the functionality added here? Thank you!

danieljaouen · 2018-11-08T14:17:37Z

@maxamillion I've written out a basic integration test for this, but I need to test it on my local machine. How can I run just that single integration test?

mattclay · 2018-11-08T14:53:30Z

@danieljaouen From the checkout of your fork:

source hacking/env-setup
ansible-test integration homebrew_bundle -v

This assumes the test is under test/integration/targets/homebrew_bundle/.

dagwieers · 2019-01-23T23:50:19Z