Compare commits
7 Commits
v2026.02.0
...
v2026.02.0
| Author | SHA1 | Date | |
|---|---|---|---|
| fc1c4bfaa8 | |||
| 34f936e21c | |||
| 5c95469ca3 | |||
| 07c7ec23d9 | |||
| 9e28004d6c | |||
| 8b3584fa9e | |||
| a202e267f7 |
26
prompt_journal.md
Normal file
26
prompt_journal.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# Prompt Journal
|
||||
|
||||
This document contains a log of the prompts used to build and refine this project.
|
||||
|
||||
## Session 1: Initial Refactor & Packaging
|
||||
|
||||
1. **Objective**: I have a ruby script that parses excel "WIF" documents that contain server names and network flows source destination ports. I need these to create an ansible inventory with attributes that detail the network connectivity required by each server in the solution. parse the WIF excel document and my existing by-hand ruby script and completely refactor them in python and increase the robustness of the parsing of network flows by using regex and allowing for shifts of cells, be aware of hidden cells and do not include a hidden cell in the output. Some cells may be visually the same cell with formatting/styling but in fact be different cells within the spreasheet - try to accomodate this. Ensure that only flows where the servers listed on the Servers tab are included in the resulting ansible inventory. the new python refactored script should allow me to take another WIF file with different servers and network flows and generate another ansible inventory file. You can see the two starting files to work with in the current project folder
|
||||
2. **Packaging**: is there a way to package this
|
||||
3. **Executable**: yes make me an exe
|
||||
4. **Documentation**: create a readme.md that details how to run this
|
||||
5. **Git Setup**: add all xls and xlsx to gitignore, add generated yml inventories to gitignore (not individually) all of them and all future. add and push this project to main at https://gitea.krisforbes.ca/krisf/wif2ansible.git. advise me of any potential ip address leakage before commiting and pushing this project
|
||||
|
||||
## Session 2: CI/CD & Logic Refinement
|
||||
|
||||
6. **CI/CD**: create me a gitea runner to generate a new release and automatically version releases each time a new push is made
|
||||
7. **Push**: push it and ensure a new exe is generated by gitea runner
|
||||
8. **Debug**: where is my bundled exe in my release
|
||||
9. **Debug**: my release should contain an exe downloadable from the releases tab in git but it does not
|
||||
10. **Debug**: error
|
||||
11. **Debug**: error again
|
||||
12. **Logic Update (Ports/DNS)**: when you parse a range of ports to be added to the result, only add the first, last, and middle port. examine the to_mgt_ip function in my original ruby script, this function converts the production interface public ipv4 address listed in the flows tab to the management private nic name by using DNS. please ensure this is implemented in the python version and push the new version
|
||||
13. **Logic Update (Server Tab)**: thats a good point, you can also use the server's tab of the wif to ensure the name is used for the source so our ansible playbook can connect to the server. With the production ipv4, we have no ability to connect. use the server's tab of the WIF first and fallback to my ruby DNS method
|
||||
14. **Release**: push a new version
|
||||
15. **Output Format**: in the genrrated yaml file, i should see all: hosts : and the entires under this should not be IP addresses, they should be the server names from mapping the servers tab of the excel file
|
||||
16. **Refining Output**: the server name key should not contain SRV### this is part of a reference and is not relevant except to provide mapping from the flows tab information to the servers information, please consider this SRV### information in your servers tab matching logic
|
||||
17. **Documentation**: add a prompt journal to this project that cotnains a copy of all prompts used and automatically adds new prompts as i send them
|
||||
46
test_inventory_keys.py
Normal file
46
test_inventory_keys.py
Normal file
@@ -0,0 +1,46 @@
|
||||
import unittest
|
||||
from wif2ansible.models import Server, Flow
|
||||
from wif2ansible.inventory import generate_inventory
|
||||
|
||||
class TestInventoryKeys(unittest.TestCase):
|
||||
def test_inventory_keys_are_hostnames(self):
|
||||
# Create a server with Ref, Hostname, IP
|
||||
s1 = Server(reference="SERVER_REF_01", hostname="server01", ip_addresses=["192.168.1.10"], platform="windows")
|
||||
|
||||
# Create a flow matching this server
|
||||
f1 = Flow(flow_id="1", source_ip="192.168.1.10", destination_ip="10.0.0.1", ports=[80])
|
||||
|
||||
servers = {"SERVER_REF_01": s1}
|
||||
flows = [f1]
|
||||
|
||||
inventory = generate_inventory(servers, flows)
|
||||
|
||||
# Verify stricture
|
||||
hosts = inventory['all']['hosts']
|
||||
|
||||
# Key should be HOSTNAME "server01" (prioritized over Ref)
|
||||
self.assertIn("server01", hosts)
|
||||
self.assertNotIn("192.168.1.10", hosts)
|
||||
|
||||
# Check variables
|
||||
host_vars = hosts["server01"]
|
||||
self.assertEqual(host_vars['ansible_host'], "192.168.1.10")
|
||||
self.assertEqual(host_vars['ansible_connection'], "winrm")
|
||||
|
||||
def test_clean_reference_logic(self):
|
||||
from wif2ansible.parsers import clean_reference
|
||||
|
||||
# Test cases
|
||||
self.assertEqual(clean_reference("SRV123 MyServer"), "MyServer")
|
||||
self.assertEqual(clean_reference("SVR999 AnotherServer"), "AnotherServer")
|
||||
self.assertEqual(clean_reference("srv001 lowercase"), "lowercase")
|
||||
self.assertEqual(clean_reference("SvR555 MixedCase"), "MixedCase")
|
||||
self.assertEqual(clean_reference("JustName"), "JustName")
|
||||
self.assertEqual(clean_reference("SRV123"), "") # Should be empty? or handle?
|
||||
# If it's just SRV123, strip returns empty.
|
||||
# User said "never include these in output".
|
||||
# If the server is ONLY named SRV123, what then?
|
||||
# Assuming there is usually a name.
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
||||
@@ -2,7 +2,7 @@ import openpyxl
|
||||
from openpyxl.worksheet.worksheet import Worksheet
|
||||
from typing import List, Dict, Tuple, Optional
|
||||
from .models import Server, Flow
|
||||
from .parsers import parse_ports, parse_ip, clean_header
|
||||
from .parsers import parse_ports, parse_ip, clean_header, clean_reference
|
||||
|
||||
from openpyxl.utils import get_column_letter
|
||||
|
||||
@@ -77,9 +77,8 @@ def read_servers(filename: str) -> Dict[str, Server]:
|
||||
print("Warning: No 'Servers' sheet found.")
|
||||
return {}
|
||||
|
||||
# keywords: reference, platform, ip address, management ip?
|
||||
# Ruby script looked for: reference, type, alias, platform, middleware
|
||||
header_keywords = ['reference', 'platform', 'ip address']
|
||||
# keywords: reference, platform, ip address, management ip, production ip, server name
|
||||
header_keywords = ['reference', 'platform', 'ip address', 'production ip', 'server name']
|
||||
|
||||
header_row_idx, col_map = find_header_row(target_sheet, header_keywords)
|
||||
|
||||
@@ -97,8 +96,10 @@ def read_servers(filename: str) -> Dict[str, Server]:
|
||||
|
||||
# Extract data
|
||||
ref_idx = col_map.get('reference')
|
||||
name_idx = col_map.get('server name') # User confirmed header
|
||||
plat_idx = col_map.get('platform')
|
||||
ip_idx = col_map.get('ip address') # Generic IP
|
||||
ip_idx = col_map.get('ip address') # Generic/Management IP
|
||||
prod_ip_idx = col_map.get('production ip') # Specific Production IP
|
||||
|
||||
# Helper to get value
|
||||
def get_val(idx):
|
||||
@@ -110,20 +111,33 @@ def read_servers(filename: str) -> Dict[str, Server]:
|
||||
if not ref or ref.lower() == 'example':
|
||||
continue
|
||||
|
||||
plat = get_val(plat_idx) or 'unknown'
|
||||
ip_raw = get_val(ip_idx)
|
||||
# Hostname Logic:
|
||||
# 1. Use 'Server Name' column if available (e.g. ITSMDEV-5009898)
|
||||
# 2. Fallback to cleaned Reference (Stripping SRV###)
|
||||
server_name_raw = get_val(name_idx)
|
||||
final_hostname = server_name_raw if server_name_raw else clean_reference(ref)
|
||||
|
||||
ip_addr = None
|
||||
plat = get_val(plat_idx) or 'unknown'
|
||||
|
||||
# Parse Management IP
|
||||
# Support multiple IPs
|
||||
ip_raw = get_val(ip_idx)
|
||||
ip_list = []
|
||||
if ip_raw:
|
||||
ips = parse_ip(ip_raw)
|
||||
if ips:
|
||||
ip_addr = ips[0] # Take first valid IP
|
||||
ip_list = parse_ip(ip_raw)
|
||||
|
||||
# Parse Production IP
|
||||
prod_ip_raw = get_val(prod_ip_idx)
|
||||
prod_ip_list = []
|
||||
if prod_ip_raw:
|
||||
prod_ip_list = parse_ip(prod_ip_raw)
|
||||
|
||||
s = Server(
|
||||
reference=ref,
|
||||
hostname=ref, # Default hostname to reference
|
||||
hostname=final_hostname,
|
||||
platform=plat,
|
||||
ip_address=ip_addr
|
||||
ip_addresses=ip_list,
|
||||
production_ips=prod_ip_list
|
||||
)
|
||||
servers[ref] = s
|
||||
|
||||
|
||||
@@ -18,8 +18,14 @@ def generate_inventory(servers: Dict[str, Server], flows: List[Flow]) -> Dict[st
|
||||
|
||||
ip_to_server = {}
|
||||
for s in servers.values():
|
||||
if s.ip_address:
|
||||
ip_to_server[s.ip_address] = s
|
||||
# Index all Management IPs
|
||||
for ip in s.ip_addresses:
|
||||
ip_to_server[ip] = s
|
||||
|
||||
# Index all Production IPs
|
||||
for ip in s.production_ips:
|
||||
ip_to_server[ip] = s
|
||||
|
||||
# Also index by reference/hostname for DNS matches
|
||||
if s.reference:
|
||||
ip_to_server[s.reference.lower()] = s
|
||||
@@ -59,8 +65,8 @@ def generate_inventory(servers: Dict[str, Server], flows: List[Flow]) -> Dict[st
|
||||
match_count += 1
|
||||
|
||||
# Prepare host entry if new
|
||||
# We use the IP as the key in inventory 'hosts'
|
||||
host_key = server.ip_address
|
||||
# We use the Hostname (from Server Name col) -> Reference (cleaned) -> IP match
|
||||
host_key = server.hostname or server.reference or server.primary_ip
|
||||
|
||||
if host_key not in inventory_hosts:
|
||||
host_vars = server.get_ansible_vars()
|
||||
|
||||
@@ -5,7 +5,19 @@ from typing import List, Dict, Optional, Any
|
||||
class Server:
|
||||
reference: str
|
||||
hostname: str # This might be same as reference
|
||||
ip_address: Optional[str] = None
|
||||
# Support multiple IPs per field (lists)
|
||||
ip_addresses: List[str] = field(default_factory=list)
|
||||
production_ips: List[str] = field(default_factory=list)
|
||||
|
||||
# helper for compatibility/primary IP
|
||||
@property
|
||||
def primary_ip(self) -> Optional[str]:
|
||||
return self.ip_addresses[0] if self.ip_addresses else None
|
||||
|
||||
@property
|
||||
def primary_prod_ip(self) -> Optional[str]:
|
||||
return self.production_ips[0] if self.production_ips else None
|
||||
|
||||
platform: str = 'unknown' # e.g. 'Windows', 'Linux'
|
||||
|
||||
def get_ansible_vars(self) -> Dict[str, Any]:
|
||||
@@ -22,6 +34,9 @@ class Server:
|
||||
# Default ssh is usually fine, but being explicit doesn't hurt
|
||||
pass
|
||||
|
||||
if self.primary_ip:
|
||||
vars['ansible_host'] = self.primary_ip
|
||||
|
||||
return vars
|
||||
|
||||
@dataclass
|
||||
|
||||
@@ -57,6 +57,21 @@ def parse_ports(port_str: str) -> List[int]:
|
||||
|
||||
return sorted(list(ports))
|
||||
|
||||
def clean_reference(ref: str) -> str:
|
||||
"""
|
||||
Cleans a server reference string.
|
||||
Specifically removes 'SRV###' type prefixes if present.
|
||||
Example: 'SRV123 MyServer' -> 'MyServer'
|
||||
"""
|
||||
if not ref:
|
||||
return ""
|
||||
|
||||
s = str(ref)
|
||||
# Remove SRV or SVR followed by digits and whitespace
|
||||
s = re.sub(r'S(RV|VR)\d+\s*', '', s, flags=re.IGNORECASE)
|
||||
# Remove leading/trailing whitespace
|
||||
return s.strip()
|
||||
|
||||
def parse_ip(ip_str: str) -> List[str]:
|
||||
"""Finds all IPv4 addresses in a string."""
|
||||
if not ip_str:
|
||||
|
||||
Reference in New Issue
Block a user