Adding ODBC module (#606)

* Adding ODBC module

* Adding symink and fixing docs and argspec

* Another sanity issue

* Hopefully last fix for elements

* Making changes suggested by felixfontein

* Making changes suggested by Andersson007

* Removing defaults and added info in description

* Fixing line too long

* More cleanup suggested by felixfontein

* Changing module call
This commit is contained in:
John Westcott IV 2020-07-17 00:39:37 -04:00 committed by GitHub
commit a86195623b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 374 additions and 0 deletions

View file

@ -0,0 +1,5 @@
destructive
shippable/posix/group1
skip/osx
skip/rhel8.0
skip/freebsd

View file

@ -0,0 +1,27 @@
---
# defaults file for test_postgresql_db
my_user: 'ansible_user'
my_pass: 'md5d5e044ccd9b4b8adc89e8fed2eb0db8a'
my_pass_decrypted: '6EjMk<hcX3<5(Yp?Xi5aQ8eS`a#Ni'
dsn: "DRIVER={PostgreSQL};Server=localhost;Port=5432;Database=postgres;Uid={{ my_user }};Pwd={{ my_pass_decrypted }};UseUnicode=True"
packages:
RedHat:
- postgresql-odbc
- unixODBC
- unixODBC-devel
- gcc
- gcc-c++
Debian:
- odbc-postgresql
- unixodbc
- unixodbc-dev
- gcc
- g++
Suse:
- psqlODBC
- unixODBC
- unixODBC-devel
- gcc
- gcc-c++
FreeBSD:
- unixODBC

View file

@ -0,0 +1,3 @@
---
dependencies:
- setup_postgresql_db

View file

@ -0,0 +1,7 @@
- name: "Install {{ ansible_os_family }} Libraries"
package:
name: "{{ packages[ansible_os_family] }}"
- name: "Install pyodbc"
pip:
name: pyodbc

View file

@ -0,0 +1,144 @@
#
# Test for proper failures without pyodbc
#
# Some of the docker images already have pyodbc installed on it
- include_tasks: no_pyodbc.yml
when: ansible_os_family != 'FreeBSD' and ansible_os_family != 'Suse' and ansible_os_family != 'Debian'
#
# Get pyodbc installed
#
- include_tasks: install_pyodbc.yml
#
# Test missing parameters & invalid DSN
#
- include_tasks: negative_tests.yml
#
# Setup DSN per env
#
- name: Changing DSN for Suse
set_fact:
dsn: "DRIVER={PSQL};Server=localhost;Port=5432;Database=postgres;Uid={{ my_user }};Pwd={{ my_pass_decrypted }};UseUnicode=True"
when: ansible_os_family == 'Suse'
- name: Changing DSN for Debian
set_fact:
dsn: "DRIVER={PostgreSQL Unicode};Server=localhost;Port=5432;Database=postgres;Uid={{ my_user }};Pwd={{ my_pass_decrypted }};UseUnicode=True"
when: ansible_os_family == 'Debian'
#
# Name setup database
#
- name: Create a user to run the tests with
postgresql_user:
name: "{{ my_user }}"
password: "{{ my_pass }}"
encrypted: 'yes'
role_attr_flags: "SUPERUSER"
db: postgres
become_user: "{{ pg_user }}"
become: True
- name: Create a table
odbc:
dsn: "{{ dsn }}"
query: |
CREATE TABLE films (
code char(5) CONSTRAINT firstkey PRIMARY KEY,
title varchar(40) NOT NULL,
did integer NOT NULL,
date_prod date,
kind varchar(10),
len interval hour to minute
);
become_user: "{{ pg_user }}"
become: True
register: results
- assert:
that:
- results is changed
#
# Insert records
#
- name: Insert a record without params
odbc:
dsn: "{{ dsn }}"
query: "INSERT INTO films (code, title, did, date_prod, kind, len) VALUES ('asdfg', 'My First Movie', 1, '2019-01-12', 'SyFi', '02:00')"
become_user: "{{ pg_user }}"
become: True
register: results
- assert:
that:
- results is changed
- name: Insert a record with params
odbc:
dsn: "{{ dsn }}"
query: "INSERT INTO films (code, title, did, date_prod, kind, len) VALUES (?, ?, ?, ?, ?, ?)"
params:
- 'qwert'
- 'My Second Movie'
- 2
- '2019-01-12'
- 'Comedy'
- '01:30'
become_user: "{{ pg_user }}"
become: True
register: results
- assert:
that:
- results is changed
- results['row_count'] == -1
- results['results'] == []
- results['description'] == []
#
# Select data
#
- name: Perform select single row without params (do not coherse changed)
odbc:
dsn: "{{ dsn }}"
query: "SELECT * FROM films WHERE code='asdfg'"
register: results
- assert:
that:
- results is changed
- results is successful
- results.row_count == 1
- name: Perform select multiple rows with params (coherse changed)
odbc:
dsn: "{{ dsn }}"
query: 'SELECT * FROM films WHERE code=? or code=?'
params:
- 'asdfg'
- 'qwert'
register: results
changed_when: False
- assert:
that:
- results is not changed
- results is successful
- results.row_count == 2
- name: Drop the table
odbc:
dsn: "{{ dsn }}"
query: "DROP TABLE films"
register: results
- assert:
that:
- results is successful
- results is changed
- results['row_count'] == -1
- results['results'] == []
- results['description'] == []

View file

@ -0,0 +1,19 @@
#
# Missing params for the module
# There is nothing you need to do here because the params are required
#
#
# Invalid DSN in the module
#
- name: "Test with an invalid DSN"
odbc:
dsn: "t1"
query: "SELECT * FROM nothing"
register: results
ignore_errors: True
- assert:
that:
- results is failed
- "'Failed to connect to DSN' in results.msg"

View file

@ -0,0 +1,11 @@
- name: Testing the module without pyodbc
odbc:
dsn: "Test"
query: "SELECT * FROM nothing"
ignore_errors: True
register: results
- assert:
that:
- results is failed
- "'Failed to import the required Python library (pyodbc) on' in results.msg"