Release procedure (#28)

* packaging routines

* release stage

* detecting runtime files

* improve(pipeline) gitignore, adjustable repo codename

* improve(pipeline) tags builds go to stable

* splitted into repo with preview builds and repo with production builds

* STAC-2599 Rearrange molecule tests

* STAC-2599 Correct setup for molecule on ec2. Update stackstate-agent installation.

* STAC-2599 Always pass bucket to publish_package script

* STAC-2599 Improving security port def

* STAC-2599 Downgrade pytest due to pytest-dev/pytest#4304

Author: Voronenko

.gitignore

@@ -84,3 +84,5 @@ kubeconfig
 */**/*.tfstate
 */**/*.tfstate.backup
 
+# vagrant
+.vagrant

.gitlab-ci.yml

@@ -5,6 +5,7 @@ stages:
 - build_and_test
 - package_test
 - publish
+- release
 
 before_script:
  - mkdir -p /go/src/github.com/StackVista
@@ -162,9 +163,23 @@ publish_deb:
     - apt-get install -y apt-utils libtool debsigs && apt-get install -y --only-upgrade libtool
   script:
     - cd $CI_PROJECT_DIR/omnibus/package-scripts && ./sign_debian_package.sh
-    - cd $CI_PROJECT_DIR/omnibus/package-scripts && ./publish_package.sh
+    - cd $CI_PROJECT_DIR/omnibus/package-scripts && ./publish_package.sh $STS_AWS_TEST_BUCKET
     - git status -s
 
+release_deb:
+  stage: release
+  dependencies:
+    - build_deb
+  before_script:
+    - apt-get install -y apt-utils libtool debsigs && apt-get install -y --only-upgrade libtool
+  script:
+    - cd $CI_PROJECT_DIR/omnibus/package-scripts && ./sign_debian_package.sh
+    - cd $CI_PROJECT_DIR/omnibus/package-scripts && ./publish_package.sh $STS_AWS_RELEASE_BUCKET stable
+  when: manual
+  only:
+    - tags
+    - triggers
+
 publish_image:
   stage: publish
   image: docker:18.06.0

README.md

@@ -48,7 +48,7 @@ care of adjusting paths and run the binary in foreground.
 You need to provide a valid API key. You can either use the config file or
 overwrite it with the environment variable like:
 ```
-DD_API_KEY=12345678990 ./bin/agent/agent -c bin/agent/dist/datadog.yaml
+STS_API_KEY=12345678990 ./bin/agent/agent -c bin/agent/dist/stackstate.yaml
 ```
 
 ## Contributing code

omnibus/package-scripts/publish_package.sh

@@ -1,10 +1,13 @@
-#!/bin/sh
+#!/bin/bash
 
-CODENAME=${1:-$CI_COMMIT_REF_NAME}
-CURRENT_BRANCH=${CODENAME:-dirty}
+TARGET_BUCKET=$1
 
-if [ -z ${STS_AWS_BUCKET+x} ]; then
-	echo "Missing AGENT_S3_BUCKET in environment"
+CODENAME=${2:-$CI_COMMIT_REF_NAME}
+TARGET_CODENAME=${CODENAME:-dirty}
+
+
+if [ -z ${TARGET_BUCKET+x} ]; then
+	echo "Missing S3 bucket parameter"
 	exit 1;
 fi
 
@@ -17,4 +20,4 @@ echo $STACKSTATE_AGENT_VERSION
 
 ls $CI_PROJECT_DIR/outcomes/pkg/*.*
 
-deb-s3 upload --sign=${SIGNING_KEY_ID} --codename ${CURRENT_BRANCH} --bucket ${STS_AWS_BUCKET:-stackstate-agent-test} $CI_PROJECT_DIR/outcomes/pkg/*.deb
+deb-s3 upload --sign=${SIGNING_KEY_ID} --codename ${TARGET_CODENAME} --bucket ${TARGET_BUCKET} $CI_PROJECT_DIR/outcomes/pkg/*.deb

omnibus/package-scripts/sign_debian_package.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 
 set -e
 

omnibus/package-scripts/version.sh

@@ -1,7 +1,5 @@
 #!/bin/bash
 
-#!/bin/bash
-
 function resolveLatest() {
 	git tag --sort=-taggerdate | head -1
 }

test/README.md

@@ -0,0 +1,20 @@
+Agent Molecule tests
+--------------------
+
+Those are integration tests that spawn new VMs in AWS and do the following:
+
+* install the agent from the debian repository
+* run a docker compose setup of the StackState receiver
+* verify assertion on the target VMs
+
+### Run
+
+Prerequisites:
+
+* export AWS_ACCESS_KEY_ID=
+* export AWS_SECRET_ACCESS_KEY=
+* export AWS_REGION=eu-west-1
+
+Make sure if you change the AWS_REGION to find the correct vpc subnet and replace it in `default/molecule.yml`.
+
+Now execute `./molecule.sh`, this will show you the help.

test/integration/tests/.yamllint

@@ -1,3 +1,4 @@
+---
 version: '3'
 
 services:
@@ -9,11 +10,11 @@ services:
       ADVERTISED_HOST: kafka
       ADVERTISED_PORT: 9092
   receiver:
-    image: "508573134510.dkr.ecr.eu-west-1.amazonaws.com/stackstate-receiver:release-1.12.0-rc1"
+    image: "508573134510.dkr.ecr.eu-west-1.amazonaws.com/stackstate-receiver:release-1.12.1-rc1"
     command: "-J-Xms128M -J-Xmx1G -J-XX:+ExitOnOutOfMemoryError -DconsoleLogging=true"
     ports:
       - 7077:7077
     depends_on:
       - kafka
     environment:
-      KAFKA_BROKERS: kafka:9092
+      KAFKA_BROKERS: kafka:9092

test/integration/tests/agent_integration/README.md

@@ -14,6 +14,10 @@
         from_port: "{{ ssh_port }}"
         to_port: "{{ ssh_port }}"
         cidr_ip: '0.0.0.0/0'
+      - proto: tcp
+        from_port: 7077  # StackState Receiver port
+        to_port: 7077
+        cidr_ip: '0.0.0.0/0'
       - proto: icmp
         from_port: 8
         to_port: -1

test/integration/tests/agent_integration/molecule/default/tests/test_agent.py

@@ -9,17 +9,17 @@ lint:
     config-file: .yamllint
 platforms:
   - name: instance-1
-    image: ami-0ac019f4fcb7cb7e6
+    image: ami-0da760e590e7de0e8  # Ubuntu 18.04
     instance_type: t2.micro
-    vpc_subnet_id: subnet-1b9d526d
-    region: us-east-1
+    vpc_subnet_id: subnet-41c8f224  # eu-west-1a
+    region: eu-west-1
     groups:
       - agent_vm
   - name: instance-2
-    image: ami-0ac019f4fcb7cb7e6
+    image: ami-0da760e590e7de0e8  # Ubuntu 18.04
     instance_type: t2.small
-    vpc_subnet_id: subnet-1b9d526d
-    region: us-east-1
+    vpc_subnet_id: subnet-41c8f224  # eu-west-1a
+    region: eu-west-1
     groups:
       - receiver_vm
 provisioner:

test/integration/tests/agent_integration/.yamllint renamed to test/molecule-role/.yamllint

@@ -2,4 +2,4 @@
 - name: Converge
   hosts: all
   roles:
-    - role: agent_integration
+    - role: molecule-role

test/integration/docker-compose.yml renamed to test/molecule-role/docker-compose.yml

@@ -1,5 +1,5 @@
 ---
-- name: Prepare
+- name: Prepare Receiver
   hosts: receiver_vm
   gather_facts: false
   tasks:
@@ -36,7 +36,7 @@
         name: ubuntu
         groups: docker
         append: True
-    - name: Reboot immediately if there was a change.
+    - name: Restart sshd to apply group change
       shell: sleep 1; pkill -u {{ ansible_ssh_user }} sshd
       async: 3
       poll: 2
@@ -45,7 +45,7 @@
         name: awscli
         state: present
       become: true
-    - name: ensure aws config directory exists
+    - name: Ensure .aws config directory exists
       file:
         path: /home/ubuntu/.aws/
         recurse: yes
@@ -75,45 +75,46 @@
         mode: "0755"
     - name: Copy Docker Compose file
       copy:
-        src: ../../../../docker-compose.yml
+        src: ../../docker-compose.yml
         dest: /home/ubuntu/docker-compose.yml
     - name: Use Docker Service to run
       command: docker-compose up -d
       args:
         chdir: /home/ubuntu/
-    - name: Open ec2_group security port
-      command: aws ec2 authorize-security-group-ingress --group-name molecule --protocol tcp --port 7077 --cidr 0.0.0.0/0
-      ignore_errors: true
-- name: Prepare
+- name: Prepare Agent
   hosts: agent_vm
   gather_facts: false
   tasks:
     - name: Install python for Ansible
       raw: test -e /usr/bin/python || (apt -y update && apt install -y python-minimal python-zipstream python-pip)
       become: true
       changed_when: false
-    - name: Add StackState-Agent APT repository
+    - name: Add stackstate-agent Apt signing key
+      become: true
+      apt_key:
+        url: https://s3.amazonaws.com/stackstate-agent-test/gpg
+        state: present
+    - name: Add stackstate-agent Apt repository
       become: true
       apt_repository:
-        repo: deb [trusted=yes] https://s3.amazonaws.com/stackstate-agent-test master main
+        repo: deb https://s3.amazonaws.com/stackstate-agent-test master main
     - name: Install StackState-Agent
       become: true
       apt:
-        name: datadog-agent
+        name: stackstate-agent
         state: present
-        allow_unauthenticated: yes
         update_cache: yes
     - name: Configure StackState-Agent
       copy:
         content: |
           # The host of the Datadog intake server to send Agent data to
-          dd_url: http://{{ hostvars['instance-2']['ansible_host'] }}:7077/stsAgent
+          sts_url: http://{{ hostvars['instance-2']['ansible_host'] }}:7077/stsAgent
           api_key: API_KEY
-        dest: /etc/datadog-agent/datadog.yaml
+        dest: /etc/stackstate-agent/stackstate.yaml
       become: true
-    - name: Run StackState-Agent
+    - name: Run stackstate-agent
       become: true
       systemd:
-        name: datadog-agent
+        name: stackstate-agent
         state: started
         daemon_reload: yes

test/integration/tests/agent_integration/molecule/default/create.yml renamed to test/molecule-role/molecule/default/create.yml

@@ -0,0 +1,18 @@
+import os
+import testinfra.utils.ansible_runner
+
+testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+    os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('agent_vm')
+
+
+def test_stackstate_agent_is_installed(host):
+    agent = host.package("stackstate-agent")
+    assert agent.is_installed
+    # TODO
+    # assert agent.version.startswith("2")
+
+
+def test_stackstate_agent_running_and_enabled(host):
+    agent = host.service("stackstate-agent")
+    assert agent.is_running
+    assert agent.is_enabled