Add Yarn module (#19026)

* Add yarn module based off of NPM module, adjust syntax for install cmd

* Update author list

* Add Return docbloc

* Remove extra var assignment

* Always return output without emojis, small changes for yarn 0.16.1

* Move import line, add ANSIBLE_METADATA, bump version_added

* Updating module format to meet newest lint requirements. Update options and example docs.

* Bring back RETURN block and main() execution.

* All trailing whitespace removed.

* Remove json try/except.

* Add initial pass at setting up Yarn integration tests.

* Add better handling for latest and removal states. Add tests for upgrading a single package.

* Fix issue where state=latest for installing all packages caused failure.

* Set yarn bin to latest version for tests. Fix sanity tests.

* Switch template task to copy task in yarn integration tests.

test/integration/targets/yarn/aliases

@@ -0,0 +1,3 @@
+posix/ci/group1
+destructive
+skip/freebsd

test/integration/targets/yarn/tasks/main.yml

@@ -0,0 +1,28 @@
+# Yarn package manager integration tests
+# (c) 2018 David Gunter, <david.gunter@tivix.com>
+
+# This file is part of Ansible
+#
+# Ansible is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Ansible is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
+
+# ============================================================
+
+- include: run.yml
+  vars:
+    nodejs_version: '{{ item.node_version }}'
+    nodejs_path: 'node-v{{ nodejs_version }}-{{ ansible_system|lower }}-x{{ ansible_userspace_bits }}'
+    yarn_version: '{{ item.yarn_version }}'
+  with_items:
+    - {node_version: 4.8.0, yarn_version: 1.6.0}  # Lowest compatible nodejs version
+    - {node_version: 8.0.0, yarn_version: 1.6.0}

test/integration/targets/yarn/tasks/run.yml

@@ -0,0 +1,114 @@
+- name: 'Create directory for Node'
+  file:
+    path: /usr/local/lib/nodejs
+    state: directory
+
+- name: 'Download Nodejs'
+  unarchive:
+    src: 'https://nodejs.org/dist/v{{ nodejs_version }}/{{ nodejs_path }}.tar.gz'
+    dest: '{{ output_dir }}'
+    remote_src: yes
+    creates: '{{ output_dir }}/{{ nodejs_path }}.tar.gz'
+
+- name: 'Download Yarn'
+  unarchive:
+    src: 'https://yarnpkg.com/downloads/{{yarn_version}}/yarn-v{{yarn_version}}.tar.gz'
+    dest: '{{ output_dir }}'
+    remote_src: yes
+    creates: '{{ output_dir }}/yarn-v{{yarn_version}}_pkg.tar.gz'
+
+- name: 'Copy node to directory created earlier'
+  command: "mv {{ output_dir }}/{{ nodejs_path }} /usr/local/lib/nodejs/{{nodejs_path}}"
+
+# Clean up before running tests
+- name: Remove any previous Nodejs modules
+  file:
+    path: '{{output_dir}}/node_modules'
+    state: absent
+
+# Set vars for our test harness
+- vars:
+    #node_bin_path: "/usr/local/lib/nodejs/node-v{{nodejs_version}}/bin"
+    node_bin_path: "/usr/local/lib/nodejs/{{ nodejs_path }}/bin"
+    yarn_bin_path: "{{ output_dir }}/yarn-v{{ yarn_version }}/bin"
+    package: 'iconv-lite'
+  environment:
+    PATH: "{{ node_bin_path }}:{{ansible_env.PATH}}"
+  block:
+
+    # Get the version of Yarn and register to a variable
+    - shell: '{{ yarn_bin_path }}/yarn --version'
+      environment:
+        PATH: '{{ node_bin_path }}:{{ ansible_env.PATH }}'
+      register: yarn_version
+
+    - name: 'Create dummy package.json'
+      copy:
+        src: templates/package.j2
+        dest: '{{ output_dir }}/package.json'
+
+    - name: 'Install all packages.'
+      yarn:
+        path: '{{ output_dir }}'
+        executable: '{{ yarn_bin_path }}/yarn'
+        state: present
+      environment:
+        PATH: '{{ node_bin_path }}:{{ ansible_env.PATH }}'
+
+    - name: 'Install the same package from package.json again.'
+      yarn:
+        path: '{{ output_dir }}'
+        executable: '{{ yarn_bin_path }}/yarn'
+        name: '{{ package }}'
+        state: present
+      environment:
+        PATH: '{{ node_bin_path }}:{{ ansible_env.PATH }}'
+      register: yarn_install
+
+    - assert:
+        that:
+          - not (yarn_install is changed)
+
+    - name: 'Install package with explicit version (older version of package)'
+      yarn:
+        path: '{{ output_dir }}'
+        executable: '{{ yarn_bin_path }}/yarn'
+        name: left-pad
+        version: 1.1.0
+        state: present
+      environment:
+        PATH: '{{ node_bin_path }}:{{ ansible_env.PATH }}'
+      register: yarn_install_old_package
+
+    - assert:
+        that:
+          - yarn_install_old_package is changed
+
+    - name: 'Upgrade old package'
+      yarn:
+        path: '{{ output_dir }}'
+        executable: '{{ yarn_bin_path }}/yarn'
+        name: left-pad
+        state: latest
+      environment:
+        PATH: '{{ node_bin_path }}:{{ ansible_env.PATH }}'
+      register: yarn_update_old_package
+
+    - assert:
+        that:
+          - yarn_update_old_package is changed
+
+    - name: 'Remove a package'
+      yarn:
+        path: '{{ output_dir }}'
+        executable: '{{ yarn_bin_path }}/yarn'
+        name: '{{ package }}'
+        state: absent
+      environment:
+        PATH: '{{ node_bin_path }}:{{ ansible_env.PATH }}'
+      register: yarn_uninstall_package
+
+    - name: 'Assert package removed'
+      assert:
+        that:
+          - yarn_uninstall_package is changed

test/integration/targets/yarn/templates/package.j2

@@ -0,0 +1,8 @@
+{
+  "name": "ansible-yarn-testing",
+  "version": "1.0.0",
+  "license": "MIT",
+  "dependencies": {
+    "iconv-lite": "^0.4.21"
+  }
+}