Skip to content

Commit 74954b3

Browse files
emepegeemepege
authoredJan 7, 2021
Merge pull request #12 from idealista/develop
v3.0.0
·
3.1.03.0.0
2 parents 8c9852c + f16a458 commit 74954b3

27 files changed

+982
-182
lines changed
 

‎.github/ISSUE_TEMPLATE.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--
22
33
Have you read Idealista's Code of Conduct? By filling an Issue, you are expected to comply with it,
4-
including treating everyone with respect: https://github.com/idealista/idealista/blob/master/CODE_OF_CONDUCT.md
4+
including treating everyone with respect: https://github.com/idealista/opengrok_role/blob/master/CODE_OF_CONDUCT.md
55
66
-->
77

‎.gitignore

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
# Retry files after playbook failures
1+
# Ansible
22
*.retry
33

4-
# Tests folders
5-
*.molecule
6-
*.cache
7-
*.vagrant
4+
# Molecule
5+
.molecule

‎.travis.yml

+8-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
11
---
22
language: python
3-
python: "2.7.13"
4-
3+
python: "2.7.15"
54
sudo: required
65

6+
env:
7+
- PIPENV_IGNORE_VIRTUALENVS=1
8+
79
services:
810
- docker
11+
912
install:
10-
- pip install ansible==2.3.1.0
11-
- pip install molecule==1.25.0
12-
- pip install docker
13+
- pip install pipenv==2018.11.26
14+
- pipenv install -r test-requirements.txt
1315
script:
14-
- molecule test --driver docker
16+
- pipenv run molecule test
1517

1618
notifications:
1719
webhooks: https://galaxy.ansible.com/api/v1/notifications/

‎.yamllint

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
extends: default
3+
4+
rules:
5+
braces:
6+
max-spaces-inside: 1
7+
level: error
8+
brackets:
9+
max-spaces-inside: 1
10+
level: error
11+
line-length: disable
12+
# NOTE(retr0h): Templates no longer fail this lint rule.
13+
# Uncomment if running old Molecule templates.
14+
# truthy: disable
15+
16+
ignore: |
17+
.molecule/
18+
molecule/

‎CHANGELOG.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,26 @@
33
All notable changes to this project will be documented in this file.
44
This project adheres to [Semantic Versioning](http://semver.org/) and [Keep a changelog](https://github.com/olivierlacan/keep-a-changelog).
55

6-
## [Unreleased](https://github.com/idealista/opengrok-role/tree/develop)
6+
## [Unreleased](https://github.com/idealista/opengrok_role/tree/develop)
7+
### Fixed
8+
### Added
9+
### Changed
10+
### Removed
11+
12+
13+
## [3.0.0](https://github.com/idealista/opengrok_role/tree/3.0.0)
14+
[Full Changelog](https://github.com/idealista/opengrok_role/compare/3.0.0...2.0.0)
15+
### Fixed
16+
- *[#9](https://github.com/idealista/opengrok_role/issues/9) [REFACTOR] Update configuration to fix tests execution* @emepege
17+
### Changed
18+
- *[#8](https://github.com/idealista/opengrok_role/issues/8) [REFACTOR] Rename role using underscore* @emepege
19+
- *[#5](https://github.com/idealista/opengrok_role/issues/5) Upgrade to Molecule v2 and Ansible minimum version 2.4.5.0* @jnogol
720

8-
## [2.0.0](https://github.com/idealista/opengrok-role/tree/2.0.0)
9-
[Full Changelog](https://github.com/idealista/opengrok-role/compare/2.0.0...1.0.0)
21+
## [2.0.0](https://github.com/idealista/opengrok_role/tree/2.0.0)
22+
[Full Changelog](https://github.com/idealista/opengrok_role/compare/2.0.0...1.0.0)
1023

1124
### Fixed
12-
- *[#1](https://github.com/idealista/opengrok-role/issues/1) Instance base and sources root not differentiated* @jnogol
25+
- *[#1](https://github.com/idealista/opengrok_role/issues/1) Instance base and sources root not differentiated* @jnogol
1326

14-
## [1.0.0](https://github.com/idealista/opengrok-role/tree/1.0.0)
27+
## [1.0.0](https://github.com/idealista/opengrok_role/tree/1.0.0)
1528
- *First version*

‎LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright 2017 Idealista, S.A.U.
189+
Copyright 2019 Idealista, S.A.U.
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

‎Pipfile

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[[source]]
2+
url = "https://pypi.org/simple"
3+
verify_ssl = true
4+
name = "pypi"
5+
6+
[packages]
7+
ansible = "==2.7.0"
8+
molecule = "==2.20.1"
9+
docker = "==3.7.2"
10+
11+
[dev-packages]
12+
13+
[requires]
14+
python_version = "2.7"

‎Pipfile.lock

+769
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md

+17-22
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
![Logo](https://raw.githubusercontent.com/idealista/opengrok-role/master/logo.gif)
1+
![Logo](https://raw.githubusercontent.com/idealista/opengrok_role/master/logo.gif)
22

3-
[![Build Status](https://travis-ci.org/idealista/opengrok-role.png)](https://travis-ci.org/idealista/opengrok-role)
3+
[![Build Status](https://travis-ci.com/idealista/opengrok_role.png)](https://travis-ci.com/idealista/opengrok_role)
44

5-
# {OpenGrok Ansible role
5+
# OpenGrok Ansible role
66

77
This Ansible role installs {OpenGrok in a Debian environment. The app is deployed to a Tomcat server and will expose the endpoint `yourtomcatip:8080/source/`.
88

99
- [Getting Started](#getting-started)
10-
- [Prerequisities](#prerequisities)
11-
- [Installing](#installing)
10+
- [Prerequisities](#prerequisities)
11+
- [Installing](#installing)
1212
- [Usage](#usage)
1313
- [Testing](#testing)
1414
- [Built With](#built-with)
@@ -23,18 +23,18 @@ These instructions will get you a copy of the role for your Ansible playbook. On
2323

2424
### Prerequisities
2525

26-
Ansible 2.3.1.0 version installed.
26+
Ansible 2.4.5.0 version installed.
2727
Inventory destination should be a Debian environment.
2828
A Tomcat server needs to be installed in your host machine (you can install it using our [Tomcat role](https://github.com/idealista/tomcat-role)).
2929

30-
For testing purposes, [Molecule](https://molecule.readthedocs.io/) (version 1.25) with [Vagrant](https://www.vagrantup.com/) as driver (with [landrush](https://github.com/vagrant-landrush/landrush) plugin) and [VirtualBox](https://www.virtualbox.org/) or [Docker](https://www.docker.com/) as provider.
30+
For testing purposes, [Molecule](https://molecule.readthedocs.io/) with [Docker](https://www.docker.com/) as driver.
3131

3232
### Installing
3333

3434
Create or add to your roles dependency file (e.g requirements.yml):
3535

3636
``` yml
37-
- src: idealista.opengrok-role
37+
- src: idealista.opengrok_role
3838
version: 1.0.0
3939
name: opengrok
4040
```
@@ -60,37 +60,32 @@ Look to the [defaults](defaults/main.yml) properties file to see the possible co
6060
6161
## Testing
6262
63-
### Using Vagrant as provider
6463
```
65-
molecule test
64+
pipenv install -r test-requirements.txt
65+
pipenv run molecule test
6666
```
6767

68-
### Using Docker as provider
69-
```
70-
molecule test --driver docker
71-
```
72-
73-
See molecule.yml to check possible testing platforms. As a reminder, our tests are just compatible with Molecule 1.x
74-
7568
## Built With
7669

77-
![Ansible](https://img.shields.io/badge/ansible-2.3.1.0-green.svg)
70+
![Ansible](https://img.shields.io/badge/ansible-2.7.0-green.svg)
71+
![Molecule](https://img.shields.io/badge/molecule-2.20.1-green.svg)
72+
![Goss](https://img.shields.io/badge/goss-0.36-green.svg)
7873

7974
## Versioning
8075

81-
For the versions available, see the [tags on this repository](https://github.com/idealista/opengrok-role/tags).
76+
For the versions available, see the [tags on this repository](https://github.com/idealista/opengrok_role/tags).
8277

83-
Additionaly you can see what change in each version in the [CHANGELOG.md](CHANGELOG.md) file.
78+
Additionaly you can see what changed in each version in the [CHANGELOG.md](CHANGELOG.md) file.
8479

8580
## Authors
8681

8782
* **Idealista** - *Work with* - [idealista](https://github.com/idealista)
8883

89-
See also the list of [contributors](https://github.com/idealista/opengrok-role/contributors) who participated in this project.
84+
See also the list of [contributors](https://github.com/idealista/opengrok_role/contributors) who participated in this project.
9085

9186
## License
9287

93-
![Apache 2.0 Licence](https://img.shields.io/hexpm/l/plug.svg)
88+
![Apache 2.0 License](https://img.shields.io/hexpm/l/plug.svg)
9489

9590
This project is licensed under the [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) license - see the [LICENSE](LICENSE) file for details.
9691

‎meta/main.yml

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
galaxy_info:
3-
company: Idealista S.A.
3+
author: idealista
4+
company: Idealista S.A.U
45
description: Opengrok role
5-
min_ansible_version: 2.3.1.0
6+
min_ansible_version: 2.7.0
67
license: Apache 2.0
78
platforms:
89
- name: Debian

‎molecule.yml

-80
This file was deleted.

‎molecule/default/Dockerfile.j2

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Molecule managed
2+
3+
{% if item.registry is defined %}
4+
FROM {{ item.registry.url }}/{{ item.image }}
5+
{% else %}
6+
FROM {{ item.image }}
7+
{% endif %}
8+
9+
RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get upgrade -y && apt-get install -y python sudo bash ca-certificates systemd systemd-sysv && apt-get clean; fi

‎tests/group_vars/opengrok.yml ‎molecule/default/group_vars/opengrok/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ opengrok_stash_server: github.com
1010
opengrok_auto_index: true
1111

1212
opengrok_repositories:
13-
- { name: opengrok, url: "https://github.com/idealista/opengrok-role.git" }
13+
- { name: opengrok, url: "https://github.com/idealista/opengrok_role.git" }

‎molecule/default/molecule.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
dependency:
3+
name: galaxy
4+
driver:
5+
name: docker
6+
lint:
7+
name: yamllint
8+
enabled: true
9+
10+
platforms:
11+
- name: opengrok-container-test
12+
image: idealista/jdk:8u265-stretch-openjdk-headless
13+
privileged: true
14+
# published_ports:
15+
# - 0.0.0.0:8080:8080/tcp
16+
capabilities:
17+
- SYS_ADMIN
18+
volumes:
19+
- '/sys/fs/cgroup:/sys/fs/cgroup:ro'
20+
groups:
21+
- opengrok
22+
command: '/lib/systemd/systemd'
23+
24+
provisioner:
25+
name: ansible
26+
lint:
27+
name: ansible-lint
28+
enabled: true
29+
scenario:
30+
name: default
31+
verifier:
32+
name: goss
33+
lint:
34+
name: yamllint
35+
enabled: true

‎molecule/default/playbook.yml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
3+
- name: Converge
4+
hosts: all
5+
roles:
6+
- tomcat
7+
- opengrok_role

‎molecule/default/requirements.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
- src: idealista.tomcat_role
3+
version: 1.8.0
4+
name: tomcat

‎tests/goss/specs/opengrok.yml.j2 ‎molecule/default/tests/test_opengrok.yml

File renamed without changes.

‎molecule/default/verify.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
# This is an example playbook to execute goss tests.
3+
# Tests need distributed to the appropriate ansible host/groups
4+
# prior to execution by `goss validate`.
5+
6+
- name: Verify
7+
hosts: all
8+
become: true
9+
vars:
10+
goss_version: v0.3.16
11+
goss_arch: amd64
12+
goss_dst: /usr/local/bin/goss
13+
goss_sha256sum: 827e354b48f93bce933f5efcd1f00dc82569c42a179cf2d384b040d8a80bfbfb
14+
goss_url: "https://github.com/aelsabbahy/goss/releases/download/{{ goss_version }}/goss-linux-{{ goss_arch }}"
15+
goss_test_directory: /tmp
16+
goss_format: documentation
17+
18+
vars_files:
19+
- ../../defaults/main.yml
20+
- ./group_vars/opengrok/main.yml
21+
22+
tasks:
23+
- name: Download and install Goss
24+
get_url:
25+
url: "{{ goss_url }}"
26+
dest: "{{ goss_dst }}"
27+
sha256sum: "{{ goss_sha256sum }}"
28+
mode: 0755
29+
register: download_goss
30+
until: download_goss is succeeded
31+
retries: 3
32+
33+
- name: Copy Goss tests to remote
34+
template:
35+
src: "{{ item }}"
36+
dest: "{{ goss_test_directory }}/{{ item | basename }}"
37+
with_fileglob:
38+
- "{{ lookup('env', 'MOLECULE_VERIFIER_TEST_DIRECTORY') }}/test_*.yml"
39+
40+
- name: Register test files
41+
shell: "ls {{ goss_test_directory }}/test_*.yml"
42+
register: test_files
43+
44+
- name: Execute Goss tests
45+
command: "{{ goss_dst }} -g {{ item }} validate --format {{ goss_format }}"
46+
register: test_results
47+
with_items: "{{ test_files.stdout_lines }}"
48+
49+
- name: Display details about the Goss results
50+
debug:
51+
msg: "{{ item.stdout_lines }}"
52+
with_items: "{{ test_results.results }}"
53+
54+
- name: Fail when tests fail
55+
fail:
56+
msg: "Goss failed to validate"
57+
when: item.rc != 0
58+
with_items: "{{ test_results.results }}"

‎tasks/auto_index.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
- name: OpenGrok | Add auto_index script (provided by playbooks)
33
template:
4-
src: "{{ opengrok_auto_index_script_path}}"
4+
src: "{{ opengrok_auto_index_script_path }}"
55
dest: "{{ opengrok_remote_auto_index }}"
66
owner: "{{ opengrok_user }}"
77
group: "{{ opengrok_group }}"

‎tasks/index.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
- name: OpenGrok | Get repositories to index
33
git:
4-
accept_hostkey: yes
5-
force: yes
4+
accept_hostkey: true
5+
force: true
66
repo: "{{ item.url }}"
77
dest: "{{ opengrok_sources_root }}/{{ item.name }}"
88
with_items: "{{ opengrok_repositories }}"

‎tasks/install.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
- name: OpenGrok | Install prerequisites
33
apt:
44
pkg: "{{ item }}"
5-
update_cache: yes
5+
update_cache: true
66
cache_valid_time: 86400
77
with_items:
88
- "{{ opengrok_required_libs }}"

‎tasks/main.yml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
- name: OpenGrok | Install
3-
include: install.yml
3+
import_tasks: install.yml
44
tags:
5-
- install
5+
- opengrok_install
66

77
- name: OpenGrok | Deploy
8-
include: deploy.yml
8+
import_tasks: deploy.yml
99
tags:
10-
- deploy
10+
- opengrok_deploy
1111

1212
- name: OpenGrok | Index
13-
include: index.yml
13+
import_tasks: index.yml
1414
tags:
15-
- index
15+
- opengrok_index
1616

1717
- name: OpenGrok | Configure auto index
18-
include: auto_index.yml
18+
import_tasks: auto_index.yml
1919
tags:
20-
- cron
21-
- auto_index
20+
- opengrok_cron
21+
- opengrok_auto_index
2222
when: opengrok_auto_index

‎test-requirements.txt

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
ansible==2.7.0
2+
molecule==2.20.1
3+
docker==3.7.2

‎tests/goss/verifier.yml

-32
This file was deleted.

‎tests/playbook.yml

-6
This file was deleted.

‎tests/requirements.yml

-8
This file was deleted.

0 commit comments

Comments
 (0)
Please sign in to comment.