antelope-cli 1.2.0 → 1.2.2

package/ansible/onboarding-ca/roles/onboard_ca/tasks/main.yml

@@ -1,76 +1,193 @@
----
-- name: Validate required inputs
-  ansible.builtin.assert:
-    that:
-      - brand_name is defined and (brand_name | length) > 0
-      - jira_key is defined and (jira_key | length) > 0
-      - dest_branches is defined and (dest_branches | length) > 0
-      - bitbucket_token is defined and (bitbucket_token | length) > 0
-    fail_msg: "brand_name, jira_key, dest_branches and bitbucket_token are all required."
-
-- name: Compute effective brand assets folder
-  ansible.builtin.set_fact:
-    brand_assets_folder: >-
-      {{ brand_assets_folder
-         if (brand_assets_folder | default('') | length) > 0
-         else (brand_name | lower | regex_replace(' ', '')) }}
-
-- name: Normalize destination branch list
-  ansible.builtin.set_fact:
-    dest_branch_list: "{{ dest_branches.split(',') | map('trim') | reject('equalto', '') | list }}"
-
-# --- Reviewers: pull from the repo's Bitbucket default-reviewers config -------------
-- name: Resolve reviewers from repo default-reviewers config
-  when: (reviewers | length) == 0
-  block:
-    - name: Identify the authenticating Bitbucket account (PR author)
-      ansible.builtin.uri:
-        url: "{{ api_base }}/user"
-        headers:
-          Authorization: "Bearer {{ bitbucket_token }}"
-        return_content: true
-      register: bb_user
-
-    - name: Fetch the repository default reviewers
-      ansible.builtin.uri:
-        url: "{{ api_base }}/repositories/{{ workspace }}/{{ repo_slug }}/default-reviewers?pagelen=100"
-        headers:
-          Authorization: "Bearer {{ bitbucket_token }}"
-        return_content: true
-      register: bb_default_reviewers
-
-    # Bitbucket rejects a PR whose author is also a reviewer, so drop the authenticating account.
-    # The REST API does not auto-apply default reviewers, so we pass them explicitly.
-    # Bitbucket's PR-create reviewers array is keyed by uuid; exclude the author by account_id.
-    - name: Build reviewers list (excluding the PR author)
-      ansible.builtin.set_fact:
-        reviewers: "{{ reviewers + [{'uuid': item.uuid}] }}"
-      loop: "{{ bb_default_reviewers.json['values'] }}"
-      when: item.account_id != bb_user.json.account_id
-      loop_control:
-        label: "{{ item.display_name | default(item.uuid) }}"
-
-- name: Ensure clone parent directory exists
-  ansible.builtin.file:
-    path: "{{ work_dir | dirname }}"
-    state: directory
-    mode: "0755"
-
-- name: Clone / refresh web-client-area over SSH
-  ansible.builtin.git:
-    repo: "{{ repo_ssh_url }}"
-    dest: "{{ work_dir }}"
-    version: "{{ dest_branch_list[0] }}"
-    update: true
-    force: true
-    accept_hostkey: true
-
-- name: Onboard the brand on each destination branch
-  ansible.builtin.include_tasks: per_branch.yml
-  loop: "{{ dest_branch_list }}"
-  loop_control:
-    loop_var: dest_branch
-
-- name: Summary of pull requests
-  ansible.builtin.debug:
-    msg: "{{ pr_results | default([]) }}"
+---
+# --- Resolve secrets: prefer the provided value, else fall back to 1Password (op CLI) ---
+# The op fallback needs a signed-in `op` on the control node (op signin, or
+# OP_SERVICE_ACCOUNT_TOKEN). A missing/failed op is tolerated here; the validate step
+# below reports the still-empty token with a clear message.
+- name: Fetch the Bitbucket API token from 1Password
+  when: (bitbucket_token | default('') | length) == 0
+  ansible.builtin.command:
+    argv:
+      - op
+      - item
+      - get
+      - "{{ onepassword_bitbucket_item }}"
+      - "--fields"
+      - "label={{ onepassword_bitbucket_field }}"
+      - "--reveal"
+  register: op_bitbucket
+  changed_when: false
+  failed_when: false
+  no_log: true
+
+- name: Adopt the 1Password Bitbucket token
+  when:
+    - (bitbucket_token | default('') | length) == 0
+    - op_bitbucket is not skipped
+    - (op_bitbucket.rc | default(1)) == 0
+    - (op_bitbucket.stdout | default('') | length) > 0
+  ansible.builtin.set_fact:
+    bitbucket_token: "{{ op_bitbucket.stdout | trim }}"
+  no_log: true
+
+# Consul token is only needed when destination branches are derived (no dest_branches override).
+- name: Resolve the Consul token from the environment
+  when: (consul_token | default('') | length) == 0
+  ansible.builtin.set_fact:
+    consul_token: "{{ lookup('env', 'CONSUL_HTTP_TOKEN') }}"
+  no_log: true
+
+- name: Fetch the Consul token from 1Password
+  when:
+    - (consul_token | default('') | length) == 0
+    - (dest_branches | default('') | length) == 0
+  ansible.builtin.command:
+    argv:
+      - op
+      - item
+      - get
+      - "{{ onepassword_consul_item }}"
+      - "--fields"
+      - "label={{ onepassword_consul_field }}"
+      - "--reveal"
+  register: op_consul
+  changed_when: false
+  failed_when: false
+  no_log: true
+
+- name: Adopt the 1Password Consul token
+  when:
+    - (consul_token | default('') | length) == 0
+    - op_consul is not skipped
+    - (op_consul.rc | default(1)) == 0
+    - (op_consul.stdout | default('') | length) > 0
+  ansible.builtin.set_fact:
+    consul_token: "{{ op_consul.stdout | trim }}"
+  no_log: true
+
+- name: Validate required inputs
+  ansible.builtin.assert:
+    that:
+      - brand_name is defined and (brand_name | length) > 0
+      - jira_key_client_branding is defined and (jira_key_client_branding | length) > 0
+      - bitbucket_token is defined and (bitbucket_token | length) > 0
+      - bitbucket_email is defined and (bitbucket_email | length) > 0
+    fail_msg: >-
+      brand_name, jira_key_client_branding and bitbucket_email are required, and bitbucket_token must be
+      provided (via --extra-vars / prompt) or resolvable from 1Password item
+      '{{ onepassword_bitbucket_item }}' field '{{ onepassword_bitbucket_field }}' (op signin).
+
+- name: Compute effective brand assets folder
+  ansible.builtin.set_fact:
+    brand_assets_folder: >-
+      {{ brand_assets_folder
+         if (brand_assets_folder | default('') | length) > 0
+         else (brand_name | lower | regex_replace(' ', '')) }}
+
+# --- Destination branches: derived from the release train in Consul ------------------
+# develop is always onboarded. master-<version/prod> tracks the live release; while a new
+# release is staged (version/staging != version/prod) its master-<version/staging> exists
+# too and is onboarded as well. Once staging == prod (the release has shipped) there is a
+# single master branch. An explicit dest_branches extra-var bypasses the lookup entirely.
+- name: Resolve destination branches from Consul
+  when: (dest_branches | default('') | length) == 0
+  block:
+    - name: Consul token is required to derive destination branches
+      ansible.builtin.assert:
+        that:
+          - consul_token is defined and (consul_token | length) > 0
+        fail_msg: >-
+          consul_token is required to read version/prod and version/staging. Provide it via
+          -e consul_token=..., $CONSUL_HTTP_TOKEN, or 1Password item '{{ onepassword_consul_item }}'
+          (op signin); or pass -e dest_branches=develop,master-XX.Y to bypass the Consul lookup.
+
+    - name: Read the prod release version from Consul
+      ansible.builtin.uri:
+        url: "{{ consul_url }}/v1/kv/version/prod?raw=1"
+        headers:
+          X-Consul-Token: "{{ consul_token }}"
+        return_content: true
+      register: consul_prod
+
+    - name: Read the staging release version from Consul
+      ansible.builtin.uri:
+        url: "{{ consul_url }}/v1/kv/version/staging?raw=1"
+        headers:
+          X-Consul-Token: "{{ consul_token }}"
+        return_content: true
+      register: consul_staging
+
+    - name: Derive the destination branch list from the release versions
+      ansible.builtin.set_fact:
+        dest_branch_list: >-
+          {{ ['develop', 'master-' + (consul_prod.content | trim)]
+             + (['master-' + (consul_staging.content | trim)]
+                if (consul_staging.content | trim) != (consul_prod.content | trim) else []) }}
+
+- name: Normalize destination branch list (explicit override)
+  when: (dest_branches | default('') | length) > 0
+  ansible.builtin.set_fact:
+    dest_branch_list: "{{ dest_branches.split(',') | map('trim') | reject('equalto', '') | list }}"
+
+- name: Show the resolved destination branches
+  ansible.builtin.debug:
+    msg: "Destination branches: {{ dest_branch_list }}"
+
+# --- Reviewers: pull from the repo's Bitbucket default-reviewers config -------------
+- name: Resolve reviewers from repo default-reviewers config
+  when: (reviewers | length) == 0
+  block:
+    - name: Identify the authenticating Bitbucket account (PR author)
+      ansible.builtin.uri:
+        url: "{{ api_base }}/user"
+        url_username: "{{ bitbucket_email }}"
+        url_password: "{{ bitbucket_token }}"
+        force_basic_auth: true
+        return_content: true
+      register: bb_user
+
+    - name: Fetch the repository default reviewers
+      ansible.builtin.uri:
+        url: "{{ api_base }}/repositories/{{ workspace }}/{{ repo_slug }}/default-reviewers?pagelen=100"
+        url_username: "{{ bitbucket_email }}"
+        url_password: "{{ bitbucket_token }}"
+        force_basic_auth: true
+        return_content: true
+      register: bb_default_reviewers
+
+    # Bitbucket rejects a PR whose author is also a reviewer, so drop the authenticating account.
+    # The REST API does not auto-apply default reviewers, so we pass them explicitly.
+    # Bitbucket's PR-create reviewers array is keyed by uuid; exclude the author by account_id.
+    # Built in a single expression (not an accumulating set_fact loop, which is nondeterministic).
+    - name: Build reviewers list (excluding the PR author)
+      ansible.builtin.set_fact:
+        reviewers: >-
+          {{ bb_default_reviewers.json['values']
+             | rejectattr('account_id', 'equalto', bb_user.json.account_id)
+             | map(attribute='uuid')
+             | map('community.general.dict_kv', 'uuid')
+             | list }}
+
+- name: Ensure clone parent directory exists
+  ansible.builtin.file:
+    path: "{{ work_dir | dirname }}"
+    state: directory
+    mode: "0755"
+
+- name: Clone / refresh web-client-area over SSH
+  ansible.builtin.git:
+    repo: "{{ repo_ssh_url }}"
+    dest: "{{ work_dir }}"
+    version: "{{ dest_branch_list[0] }}"
+    update: true
+    force: true
+    accept_hostkey: true
+
+- name: Onboard the brand on each destination branch
+  ansible.builtin.include_tasks: per_branch.yml
+  loop: "{{ dest_branch_list }}"
+  loop_control:
+    loop_var: dest_branch
+
+- name: Summary of pull requests
+  ansible.builtin.debug:
+    msg: "{{ pr_results | default([]) }}"

package/ansible/onboarding-ca/roles/onboard_ca/tasks/per_branch.yml

@@ -1,106 +1,107 @@
----
-# Runs once per destination branch. `dest_branch` is the loop var.
-
-- name: "[{{ dest_branch }}] Compose source branch name"
-  ansible.builtin.set_fact:
-    branch_prefix: "{{ 'hotfix' if dest_branch is match('(master|release)') else 'feature' }}"
-
-- name: "[{{ dest_branch }}] Set source branch"
-  ansible.builtin.set_fact:
-    source_branch: "{{ branch_prefix }}/{{ jira_key }}-onboarding-{{ brand_assets_folder }}"
-
-- name: "[{{ dest_branch }}] Fetch all remote branches"
-  ansible.builtin.command:
-    cmd: git fetch origin --prune
-    chdir: "{{ work_dir }}"
-  changed_when: false
-
-- name: "[{{ dest_branch }}] Does the source branch already exist on origin?"
-  ansible.builtin.command:
-    cmd: "git ls-remote --exit-code --heads origin {{ source_branch }}"
-    chdir: "{{ work_dir }}"
-  register: remote_src
-  failed_when: false
-  changed_when: false
-
-# Base the working branch on its own remote head if it already exists (idempotent re-run),
-# otherwise on the destination branch.
-- name: "[{{ dest_branch }}] Check out the working branch"
-  ansible.builtin.command:
-    cmd: >-
-      git checkout -B {{ source_branch }}
-      {{ ('origin/' + source_branch) if remote_src.rc == 0 else ('origin/' + dest_branch) }}
-    chdir: "{{ work_dir }}"
-
-- name: "[{{ dest_branch }}] Generate brand files via antelope-cli"
-  ansible.builtin.command:
-    argv:
-      - npx
-      - "antelope-cli@{{ antelope_cli_version }}"
-      - onboarding-ca
-      - --brand_assets_folder
-      - "{{ brand_assets_folder }}"
-    chdir: "{{ work_dir }}"
-  environment:
-    CI: "true"
-  changed_when: true
-
-- name: "[{{ dest_branch }}] Stage changes"
-  ansible.builtin.command:
-    cmd: git add -A
-    chdir: "{{ work_dir }}"
-  changed_when: false
-
-- name: "[{{ dest_branch }}] Detect staged changes"
-  ansible.builtin.command:
-    cmd: git diff --cached --quiet
-    chdir: "{{ work_dir }}"
-  register: staged
-  failed_when: false
-  changed_when: false
-
-- name: "[{{ dest_branch }}] Commit"
-  ansible.builtin.command:
-    cmd: >-
-      git -c user.name="{{ git_user_name }}" -c user.email="{{ git_user_email }}"
-      commit -m "{{ jira_key }}: On-Boarding {{ brand_name }} Client Branding"
-    chdir: "{{ work_dir }}"
-  when: staged.rc == 1
-
-- name: "[{{ dest_branch }}] Push source branch"
-  ansible.builtin.command:
-    cmd: "git push -u origin {{ source_branch }}"
-    chdir: "{{ work_dir }}"
-  when: staged.rc == 1
-
-- name: "[{{ dest_branch }}] Open pull request"
-  ansible.builtin.uri:
-    url: "{{ api_base }}/repositories/{{ workspace }}/{{ repo_slug }}/pullrequests"
-    method: POST
-    headers:
-      Authorization: "Bearer {{ bitbucket_token }}"
-    body_format: json
-    body:
-      title: "{{ jira_key }}: On-Boarding {{ brand_name }} Client Branding"
-      description: "{{ jira_key }}: On-Boarding {{ brand_name }} Client Branding"
-      source:
-        branch:
-          name: "{{ source_branch }}"
-      destination:
-        branch:
-          name: "{{ dest_branch }}"
-      reviewers: "{{ reviewers }}"
-      close_source_branch: true
-    return_content: true
-    status_code: [201, 400]   # 400 tolerated: a PR for this source->dest already exists
-  register: pr_response
-
-- name: "[{{ dest_branch }}] Record PR result"
-  ansible.builtin.set_fact:
-    pr_results: >-
-      {{ (pr_results | default([])) + [{
-           'destination': dest_branch,
-           'source': source_branch,
-           'status': pr_response.status,
-           'url': (pr_response.json.links.html.href | default('(already exists or not created)'))
-         }] }}
+---
+# Runs once per destination branch. `dest_branch` is the loop var.
+
+- name: "[{{ dest_branch }}] Compose source branch name"
+  ansible.builtin.set_fact:
+    branch_prefix: "{{ 'hotfix' if dest_branch is match('(master|release)') else 'feature' }}"
+
+- name: "[{{ dest_branch }}] Set source branch"
+  ansible.builtin.set_fact:
+    source_branch: "{{ branch_prefix }}/{{ jira_key_client_branding }}-onboarding-{{ brand_assets_folder }}"
+
+- name: "[{{ dest_branch }}] Fetch all remote branches"
+  ansible.builtin.command:
+    cmd: git fetch origin --prune
+    chdir: "{{ work_dir }}"
+  changed_when: false
+
+- name: "[{{ dest_branch }}] Does the source branch already exist on origin?"
+  ansible.builtin.command:
+    cmd: "git ls-remote --exit-code --heads origin {{ source_branch }}"
+    chdir: "{{ work_dir }}"
+  register: remote_src
+  failed_when: false
+  changed_when: false
+
+# Base the working branch on its own remote head if it already exists (idempotent re-run),
+# otherwise on the destination branch.
+- name: "[{{ dest_branch }}] Check out the working branch"
+  ansible.builtin.command:
+    cmd: >-
+      git checkout -B {{ source_branch }}
+      {{ ('origin/' + source_branch) if remote_src.rc == 0 else ('origin/' + dest_branch) }}
+    chdir: "{{ work_dir }}"
+
+- name: "[{{ dest_branch }}] Generate brand files via antelope-cli"
+  ansible.builtin.command:
+    argv:
+      - npx
+      - "antelope-cli@{{ antelope_cli_version }}"
+      - onboarding-ca
+      - --brand_assets_folder
+      - "{{ brand_assets_folder }}"
+    chdir: "{{ work_dir }}"
+  environment:
+    CI: "true"
+  changed_when: true
+
+- name: "[{{ dest_branch }}] Stage changes"
+  ansible.builtin.command:
+    cmd: git add -A
+    chdir: "{{ work_dir }}"
+  changed_when: false
+
+- name: "[{{ dest_branch }}] Detect staged changes"
+  ansible.builtin.command:
+    cmd: git diff --cached --quiet
+    chdir: "{{ work_dir }}"
+  register: staged
+  failed_when: false
+  changed_when: false
+
+- name: "[{{ dest_branch }}] Commit"
+  ansible.builtin.command:
+    cmd: >-
+      git -c user.name="{{ git_user_name }}" -c user.email="{{ git_user_email }}"
+      commit -m "{{ jira_key_client_branding }}: On-Boarding {{ brand_name }} Client Branding"
+    chdir: "{{ work_dir }}"
+  when: staged.rc == 1
+
+- name: "[{{ dest_branch }}] Push source branch"
+  ansible.builtin.command:
+    cmd: "git push -u origin {{ source_branch }}"
+    chdir: "{{ work_dir }}"
+  when: staged.rc == 1
+
+- name: "[{{ dest_branch }}] Open pull request"
+  ansible.builtin.uri:
+    url: "{{ api_base }}/repositories/{{ workspace }}/{{ repo_slug }}/pullrequests"
+    method: POST
+    url_username: "{{ bitbucket_email }}"
+    url_password: "{{ bitbucket_token }}"
+    force_basic_auth: true
+    body_format: json
+    body:
+      title: "{{ jira_key_client_branding }}: On-Boarding {{ brand_name }} Client Branding"
+      description: "{{ jira_key_client_branding }}: On-Boarding {{ brand_name }} Client Branding"
+      source:
+        branch:
+          name: "{{ source_branch }}"
+      destination:
+        branch:
+          name: "{{ dest_branch }}"
+      reviewers: "{{ reviewers }}"
+      close_source_branch: true
+    return_content: true
+    status_code: [201, 400]   # 400 tolerated: a PR for this source->dest already exists
+  register: pr_response
+
+- name: "[{{ dest_branch }}] Record PR result"
+  ansible.builtin.set_fact:
+    pr_results: >-
+      {{ (pr_results | default([])) + [{
+           'destination': dest_branch,
+           'source': source_branch,
+           'status': pr_response.status,
+           'url': (pr_response.json.links.html.href | default('(already exists or not created)'))
+         }] }}

package/ansible/onboarding-ca/roles/onboard_ca/vars/main.yml

@@ -1,6 +1,9 @@
----
-# Constants — the target repository for Client Area onboarding.
-api_base: "https://api.bitbucket.org/2.0"
-workspace: "xsitesinc"
-repo_slug: "web-client-area"
-repo_ssh_url: "git@bitbucket.org:xsitesinc/web-client-area.git"
+---
+# Constants — the target repository for Client Area onboarding.
+api_base: "https://api.bitbucket.org/2.0"
+workspace: "xsitesinc"
+repo_slug: "web-client-area"
+repo_ssh_url: "git@bitbucket.org:xsitesinc/web-client-area.git"
+
+# Consul (v2 cluster) — source of the release train used to derive destination branches.
+consul_url: "https://consul.xsites.xyz"

package/index.js

@@ -5,6 +5,8 @@ if (args[0] === "onboarding") {
     require('./onboarding');
 } else if (args[0] === "onboarding-ca") {
     require('./onboarding-ca');
+} else if (args[0] === "onboarding-crm") {
+    require('./onboarding-crm');
 } else {
     console.log("Unknown command");
 }

package/onboarding-ca/brand.js

@@ -1,13 +1,13 @@
-let brand = {
-  brandAssetsFolder: ''
-};
-
-function updateBrand(updatedBrand) {
-  brand = { ...brand, ...updatedBrand };
-}
-
-function getBrand() {
-  return brand;
-}
-
-module.exports = { updateBrand, getBrand };
+let brand = {
+  brandAssetsFolder: ''
+};
+
+function updateBrand(updatedBrand) {
+  brand = { ...brand, ...updatedBrand };
+}
+
+function getBrand() {
+  return brand;
+}
+
+module.exports = { updateBrand, getBrand };