Add --container-enabled option to `ansible-galaxy init` command. (#18157)

21 files changed, 200 insertions, 35 deletions

diff --git a/lib/ansible/galaxy/__init__.py b/lib/ansible/galaxy/__init__.py
index 8fdd24e910..129e860c90 100644
--- a/lib/ansible/galaxy/__init__.py
+++ b/lib/ansible/galaxy/__init__.py
@@ -48,46 +48,15 @@ class Galaxy(object):
 
         # load data path for resource usage
         this_dir, this_filename = os.path.split(__file__)
-        self.DATA_PATH = os.path.join(this_dir, "data")
-
-        self._default_readme = None
-        self._default_meta = None
-        self._default_test = None
-        self._default_travis = None
-
-    @property
-    def default_readme(self):
-        if self._default_readme is None:
-            self._default_readme = self._str_from_data_file('readme')
-        return self._default_readme
-
-    @property
-    def default_meta(self):
-        if self._default_meta is None:
-            self._default_meta = self._str_from_data_file('metadata_template.j2')
-        return self._default_meta
-
-    @property
-    def default_test(self):
-        if self._default_test is None:
-            self._default_test = self._str_from_data_file('test_playbook.j2')
-        return self._default_test
+        type_path = 'container_enabled' if getattr(self.options, 'container_enabled', False) else 'default'
+        self.DATA_PATH = os.path.join(this_dir, 'data', type_path)
 
     @property
-    def default_travis(self):
-        if self._default_travis is None:
-            self._default_travis = self._str_from_data_file('travis.j2')
-        return self._default_travis
+    def default_role_skeleton_path(self):
+        return self.DATA_PATH
 
     def add_role(self, role):
         self.roles[role.name] = role
 
     def remove_role(self, role_name):
         del self.roles[role_name]
-
-    def _str_from_data_file(self, filename):
-        myfile = os.path.join(self.DATA_PATH, filename)
-        try:
-            return open(myfile).read()
-        except Exception as e:
-            raise AnsibleError("Could not open %s: %s" % (filename, str(e)))
diff --git a/lib/ansible/galaxy/data/container_enabled/.travis.yml b/lib/ansible/galaxy/data/container_enabled/.travis.yml
new file mode 100644
index 0000000000..53f71f4f76
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/.travis.yml
@@ -0,0 +1,46 @@
+language: python
+dist: trusty
+sudo: required
+
+services:
+  - docker
+
+before_install:
+  - sudo apt-add-repository 'deb http://archive.ubuntu.com/ubuntu trusty-backports universe'
+  - sudo apt-get update -qq
+  - sudo apt-get install -y -o Dpkg::Options::="--force-confold" --force-yes docker-engine
+
+install:
+  # Install the latest Ansible Container and Ansible
+  - pip install git+https://github.com/ansible/ansible-container.git
+  - pip install ansible
+
+script:
+  # Make sure docker is functioning
+  - docker version
+  - docker-compose version
+  - docker info
+
+  # Create an Ansible Container project
+  - mkdir -p tests
+  - cd tests
+  - ansible-container init
+
+  # Install the role into the project
+  - echo "Installing and testing git+https://github.com/${TRAVIS_REPO_SLUG},${TRAVIS_COMMIT}"
+  - ansible-container install git+https://github.com/${TRAVIS_REPO_SLUG},${TRAVIS_COMMIT}
+
+  # Build the service image
+  - ansible-container build
+
+  # Start the service
+  - ansible-container run -d
+  - docker ps
+
+  # Run tests
+  - ansible-playbook test.yml
+
+notifications:
+  email: false
+  webhooks: https://galaxy.ansible.com/api/v1/notifications/
+
diff --git a/lib/ansible/galaxy/data/container_enabled/README.md b/lib/ansible/galaxy/data/container_enabled/README.md
new file mode 100644
index 0000000000..2de963afe9
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/README.md
@@ -0,0 +1,49 @@
+# Role Name
+
+Adds a <SERVICE_NAME> service to your [Ansible Container](https://github.com/ansible/ansible-container) project. Run the following commands
+to install the service:
+
+```
+# Set the working directory to your Ansible Container project root
+$ cd myproject
+
+# Install the service
+$ ansible-container install <USERNAME.ROLE_NAME>
+```
+
+## Requirements
+
+- [Ansible Container](https://github.com/ansible/ansible-container)
+- An existing Ansible Container project. To create a project, simply run the following:
+    ```
+    # Create an empty project directory
+    $ mkdir myproject
+
+    # Set the working directory to the new directory
+    $ cd myproject
+
+    # Initialize the project
+    $ ansible-contiainer init
+    ```
+
+- Continue listing any prerequisites here...
+
+
+## Role Variables
+
+A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set
+via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
+
+## Dependencies
+
+A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
+
+## License
+
+BSD
+
+## Author Information
+
+An optional section for the role authors to include contact information, or a website (HTML is not allowed).
+
+
diff --git a/lib/ansible/galaxy/data/container_enabled/defaults/main.yml.j2 b/lib/ansible/galaxy/data/container_enabled/defaults/main.yml.j2
new file mode 100644
index 0000000000..3da8d52cc1
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/defaults/main.yml.j2
@@ -0,0 +1,3 @@
+---
+# defaults file for {{ role_name }}
+
diff --git a/lib/ansible/galaxy/data/container_enabled/handlers/main.yml.j2 b/lib/ansible/galaxy/data/container_enabled/handlers/main.yml.j2
new file mode 100644
index 0000000000..3f4c49674d
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/handlers/main.yml.j2
@@ -0,0 +1,2 @@
+---
+# handlers file for {{ role_name }}
diff --git a/lib/ansible/galaxy/data/container_enabled/meta/container.yml.j2 b/lib/ansible/galaxy/data/container_enabled/meta/container.yml.j2
new file mode 100644
index 0000000000..f033d34110
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/meta/container.yml.j2
@@ -0,0 +1,11 @@
+# Add your Ansible Container service definitions here.
+# For example:
+  #
+  # web:
+  #   image: ubuntu:trusty
+  #   ports:
+  #     - "80:80"
+  #   command: ['/usr/bin/dumb-init', '/usr/sbin/apache2ctl', '-D', 'FOREGROUND']
+  #   dev_overrides:
+  #     environment:
+  #       - "DEBUG=1"
diff --git a/lib/ansible/galaxy/data/container_enabled/meta/main.yml.j2 b/lib/ansible/galaxy/data/container_enabled/meta/main.yml.j2
new file mode 100644
index 0000000000..7da00bc0d5
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/meta/main.yml.j2
@@ -0,0 +1,56 @@
+galaxy_info:
+  author: {{ author }}
+  description: {{ description }}
+  company: {{ company }}
+
+  # If the issue tracker for your role is not on github, uncomment the
+  # next line and provide a value
+  # issue_tracker_url: {{ issue_tracker_url }}
+
+  # Some suggested licenses:
+  # - BSD (default)
+  # - MIT
+  # - GPLv2
+  # - GPLv3
+  # - Apache
+  # - CC-BY
+  license: {{ license }}
+
+  min_ansible_container_version: 0.2.0
+
+  # If Ansible is required outside of the build container, provide the minimum version:
+  # min_ansible_version:
+
+  # Optionally specify the branch Galaxy will use when accessing the GitHub
+  # repo for this role. During role install, if no tags are available,
+  # Galaxy will use this branch. During import Galaxy will access files on
+  # this branch. If Travis integration is configured, only notifications for this
+  # branch will be accepted. Otherwise, in all cases, the repo's default branch
+  # (usually master) will be used.
+  #github_branch:
+
+  #
+  # Below are all platforms currently available in Galaxy. Uncomment any that match the base images
+  # of the services defined in meta/container.yml
+  #
+  #platforms:
+  {%- for platform,versions in platforms.items() %}
+  #- name: {{ platform }}
+  #  versions:
+  #  - all
+    {%- for version in versions %}
+  #  - {{ version }}
+    {%- endfor -%}
+  {%- endfor %}
+
+  galaxy_tags:
+    - container
+    # List tags for your role here, one per line. A tag is a keyword that describes
+    # and categorizes the role. Users find roles by searching for tags.
+    #
+    # NOTE: A tag is limited to a single word comprised of alphanumeric characters.
+    #       Maximum 20 tags per role.
+
+dependencies: []
+  # List your role dependencies here, one per line. Be sure to remove the '[]' above,
+  # if you add dependencies to this list.
diff --git a/lib/ansible/galaxy/data/container_enabled/tasks/main.yml.j2 b/lib/ansible/galaxy/data/container_enabled/tasks/main.yml.j2
new file mode 100644
index 0000000000..115d841bda
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/tasks/main.yml.j2
@@ -0,0 +1,3 @@
+---
+# tasks file for {{ role_name }}
+
diff --git a/lib/ansible/galaxy/data/container_enabled/tests/ansible.cfg b/lib/ansible/galaxy/data/container_enabled/tests/ansible.cfg
new file mode 100644
index 0000000000..2f74f1b272
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/tests/ansible.cfg
@@ -0,0 +1,2 @@
+[defaults]
+inventory=./inventory
diff --git a/lib/ansible/galaxy/data/container_enabled/tests/inventory b/lib/ansible/galaxy/data/container_enabled/tests/inventory
new file mode 100644
index 0000000000..ea69cbf122
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/tests/inventory
@@ -0,0 +1,3 @@
+localhost
+
+
diff --git a/lib/ansible/galaxy/data/container_enabled/tests/test.yml.j2 b/lib/ansible/galaxy/data/container_enabled/tests/test.yml.j2
new file mode 100644
index 0000000000..224ea3113e
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/tests/test.yml.j2
@@ -0,0 +1,8 @@
+---
+- hosts: localhost
+  gather_facts: no
+  connection: local
+  tasks:
+
+  # Add tasks and assertions for testing the service here.
+
diff --git a/lib/ansible/galaxy/data/container_enabled/vars/main.yml.j2 b/lib/ansible/galaxy/data/container_enabled/vars/main.yml.j2
new file mode 100644
index 0000000000..b0524ec32a
--- /dev/null
+++ b/lib/ansible/galaxy/data/container_enabled/vars/main.yml.j2
@@ -0,0 +1,3 @@
+---
+# vars file for {{ role_name }}
+
diff --git a/lib/ansible/galaxy/data/travis.j2 b/lib/ansible/galaxy/data/default/.travis.yml
index 36bbf6208c..36bbf6208c 100644
--- a/lib/ansible/galaxy/data/travis.j2
+++ b/lib/ansible/galaxy/data/default/.travis.yml
diff --git a/lib/ansible/galaxy/data/readme b/lib/ansible/galaxy/data/default/README.md
index 225dd44b9f..225dd44b9f 100644
--- a/lib/ansible/galaxy/data/readme
+++ b/lib/ansible/galaxy/data/default/README.md
diff --git a/lib/ansible/galaxy/data/default/defaults/main.yml.j2 b/lib/ansible/galaxy/data/default/defaults/main.yml.j2
new file mode 100644
index 0000000000..3818e64c33
--- /dev/null
+++ b/lib/ansible/galaxy/data/default/defaults/main.yml.j2
@@ -0,0 +1,2 @@
+---
+# defaults file for {{ role_name }}
diff --git a/lib/ansible/galaxy/data/default/handlers/main.yml.j2 b/lib/ansible/galaxy/data/default/handlers/main.yml.j2
new file mode 100644
index 0000000000..3f4c49674d
--- /dev/null
+++ b/lib/ansible/galaxy/data/default/handlers/main.yml.j2
@@ -0,0 +1,2 @@
+---
+# handlers file for {{ role_name }}
diff --git a/lib/ansible/galaxy/data/metadata_template.j2 b/lib/ansible/galaxy/data/default/meta/main.yml.j2
index 78bccdc50d..78bccdc50d 100644
--- a/lib/ansible/galaxy/data/metadata_template.j2
+++ b/lib/ansible/galaxy/data/default/meta/main.yml.j2
diff --git a/lib/ansible/galaxy/data/default/tasks/main.yml.j2 b/lib/ansible/galaxy/data/default/tasks/main.yml.j2
new file mode 100644
index 0000000000..a988065059
--- /dev/null
+++ b/lib/ansible/galaxy/data/default/tasks/main.yml.j2
@@ -0,0 +1,2 @@
+---
+# tasks file for {{ role_name }}
diff --git a/lib/ansible/galaxy/data/default/tests/inventory b/lib/ansible/galaxy/data/default/tests/inventory
new file mode 100644
index 0000000000..878877b077
--- /dev/null
+++ b/lib/ansible/galaxy/data/default/tests/inventory
@@ -0,0 +1,2 @@
+localhost
+
diff --git a/lib/ansible/galaxy/data/test_playbook.j2 b/lib/ansible/galaxy/data/default/tests/test.yml.j2
index 45824f6051..45824f6051 100644
--- a/lib/ansible/galaxy/data/test_playbook.j2
+++ b/lib/ansible/galaxy/data/default/tests/test.yml.j2
diff --git a/lib/ansible/galaxy/data/default/vars/main.yml.j2 b/lib/ansible/galaxy/data/default/vars/main.yml.j2
new file mode 100644
index 0000000000..092d511a1e
--- /dev/null
+++ b/lib/ansible/galaxy/data/default/vars/main.yml.j2
@@ -0,0 +1,2 @@
+---
+# vars file for {{ role_name }}