Skip to main content

For The Win

 

So much of what I want to do with automation is repetition of slight variants. I was reminded of it again last week when I was looking for a way to list the versions of certain dependencies across many versions of a product my team owns.

These dependencies are exposed through the running product's API on an "about" endpoint. They can also be found in our Gradle configuration file, build.gradle, something like this:

thingVersion = System.getenv('THING_VERSION') ?: '4.0'
otherVersion = System.getenv('OTHER_VERSION') ?: '2.3.1'
anotherVersion = System.getenv('ANOTHER_VERSION') ?: "7.6.0"

Conceptually I need to run through released versions of the product, interrogate each for the  dependencies, and aggregate them into some easily-parsable format.

If I was only after a couple of versions of the product I'd just check out the code for those versions, inspect the build.gradle files, and copy-paste the data into a text file. But it's not only a couple of versions and, ideally, I'd like to be able to re-use the same approach in future on versions we haven't released yet.

For that second need, an alternative would be to start recording the dependencies with each build. I considered that, but it means I'd now have two tasks and I think we will only need the dependency combinations occasionally.

So I want some way to automate gathering the information and I can see that this task fits the template at the top:

  • something that can be done once (get a dependency version for a given release)
  • repeated with slight variations (the dependencies, the release versions)

If there's anything clever about what I did next, it's the thinking about how to do my task once.

I can see that that API could do what I need. I could start a Docker container for every version that I was interested in and fetch data from the about endpoint. But that would be sloooooooooow.

Each of our releases is tagged and I know that it's easy to get Git to give me a list of tags on any repository. So I wondered whether there was a way to check out just the build.gradle file for all of the release versions and grep the data from it. 

A handful of searches, and a couple of false starts, later and I had the first building block:

$ git checkout my_tag build.gradle
That command, run inside a clone of our product's codebase, will update only the build.gradle file to tag my_tag.

Now I could search for the data I needed:

$ grep thingVersion build.gradle
  thingVersion = System.getenv('THING_VERSION') ?: '4.0'
And I could refine the call to get just the version by stripping out everything else:
$ grep thingVersion build.gradle | sed 's/.*\?\://'`
  '4.0'
At that point I had all the pieces:
  • a call to get the version of a particular dependency for any release
  • a list of dependencies 
  • a list of releases

Now the problem was just syntax and this is the script I ended up with:

#!/bin/bash

# get the list of tags
tags=`git tag` # find and return the build dependency get_gradle_setting_for() { build_parameter=$1 value=`grep "$build_parameter.*\=" build.gradle | sed 's/.*\?\://'` echo $value } # loop on tags, get build.gradle, find values for tag in $tags; do git checkout $tag build.gradle > /dev/null 2>&1 thing=$(get_gradle_setting_for "thingVersion") other=$(get_gradle_setting_for "otherVersion") another=$(get_gradle_setting_for "anotherVersion") echo $tag, $thing, $other, $another done

This is not a bash tutorial but I hope you can see that the thing I want to do once is in the function get_gradle_setting_for().

That function is called once for each dependency. That's one set of slight variants.

There's then a loop for another set of variants, the tags for each release.

This is how it looks when run:

$ getbuilds
v1, '4.0', '2.3.1', "7.6.0"
v2, '4.0', '2.5.0', "7.6.0"
v3, '4.2', '2.5.1', "7.6.0"
It takes a few seconds on my laptop to generate permutations for all tags. This is definitely the kind of thing we could do if and when we need it again later.

Now, for sure, the script is not particularly tidy, and has no validation or error handling, and if the build.gradle format changes it might stop working. But for this mission those things don't matter. This is a cheap solution to an occasional problem. The script is re-usable and serves as documentation for solving similar problems in future.

I mention all of this stuff not to brag but to encourage anyone feeling intimidated by automating. I Google how to do even the basics all the time. You can do the same. You already have the key thing you need: a good thinking brain.

P.S. Talking of repetition of slight variants, it makes me smile to think that I have said similar things before.
Highlighting: Pinetools
Image: https://flic.kr/p/rtgCk

Comments

Popular posts from this blog

Can Code, Can't Code, Is Useful

The Association for Software Testing is crowd-sourcing a book,  Navigating the World as a Context-Driven Tester , which aims to provide  responses to common questions and statements about testing from a  context-driven perspective . It's being edited by  Lee Hawkins  who is  posing questions on  Twitter ,   LinkedIn , Mastodon , Slack , and the AST  mailing list  and then collating the replies, focusing on practice over theory. I've decided to  contribute  by answering briefly, and without a lot of editing or crafting, by imagining that I'm speaking to someone in software development who's acting in good faith, cares about their work and mine, but doesn't have much visibility of what testing can be. Perhaps you'd like to join me?   --00-- "If testers can’t code, they’re of no use to us" My first reaction is to wonder what you expect from your testers. I am immediately interested in your working context and the way

Meet Me Halfway?

  The Association for Software Testing is crowd-sourcing a book,  Navigating the World as a Context-Driven Tester , which aims to provide  responses to common questions and statements about testing from a  context-driven perspective . It's being edited by  Lee Hawkins  who is  posing questions on  Twitter ,   LinkedIn , Mastodon , Slack , and the AST  mailing list  and then collating the replies, focusing on practice over theory. I've decided to  contribute  by answering briefly, and without a lot of editing or crafting, by imagining that I'm speaking to someone in software development who's acting in good faith, cares about their work and mine, but doesn't have much visibility of what testing can be. Perhaps you'd like to join me?   --00-- "Stop answering my questions with questions." Sure, I can do that. In return, please stop asking me questions so open to interpretation that any answer would be almost meaningless and certa

Testing (AI) is Testing

Last November I gave a talk, Random Exploration of a Chatbot API , at the BCS Testing, Diversity, AI Conference .  It was a nice surprise afterwards to be offered a book from their catalogue and I chose Artificial Intelligence and Software Testing by Rex Black, James Davenport, Joanna Olszewska, Jeremias Rößler, Adam Leon Smith, and Jonathon Wright.  This week, on a couple of train journeys around East Anglia, I read it and made sketchnotes. As someone not deeply into this field, but who has been experimenting with AI as a testing tool at work, I found the landscape view provided by the book interesting, particularly the lists: of challenges in testing AI, of approaches to testing AI, and of quality aspects to consider when evaluating AI.  Despite the hype around the area right now there's much that any competent tester will be familiar with, and skills that translate directly. Where there's likely to be novelty is in the technology, and the technical domain, and the effect of

Testers are Gate-Crashers

  The Association for Software Testing is crowd-sourcing a book,  Navigating the World as a Context-Driven Tester , which aims to provide  responses to common questions and statements about testing from a  context-driven perspective . It's being edited by  Lee Hawkins  who is  posing questions on  Twitter ,   LinkedIn , Mastodon , Slack , and the AST  mailing list  and then collating the replies, focusing on practice over theory. I've decided to  contribute  by answering briefly, and without a lot of editing or crafting, by imagining that I'm speaking to someone in software development who's acting in good faith, cares about their work and mine, but doesn't have much visibility of what testing can be. Perhaps you'd like to join me?   --00-- "Testers are the gatekeepers of quality" Instinctively I don't like the sound of that, but I wonder what you mean by it. Perhaps one or more of these? Testers set the quality sta

Postman Curlections

My team has been building a new service over the last few months. Until recently all the data it needs has been ingested at startup and our focus has been on the logic that processes the data, architecture, and infrastructure. This week we introduced a couple of new endpoints that enable the creation (through an HTTP POST) and update (PUT) of the fundamental data type (we call it a definition ) that the service operates on. I picked up the task of smoke testing the first implementations. I started out by asking the system under test to show me what it can do by using Postman to submit requests and inspecting the results. It was the kinds of things you'd imagine, including: submit some definitions (of various structure, size, intent, name, identifiers, etc) resubmit the same definitions (identical, sharing keys, with variations, etc) retrieve the submitted definitions (using whatever endpoints exist to show some view of them) compare definitions I submitted fro

Build Quality

  The Association for Software Testing is crowd-sourcing a book,  Navigating the World as a Context-Driven Tester , which aims to provide  responses to common questions and statements about testing from a  context-driven perspective . It's being edited by  Lee Hawkins  who is  posing questions on  Twitter ,   LinkedIn , Mastodon , Slack , and the AST  mailing list  and then collating the replies, focusing on practice over theory. I've decided to  contribute  by answering briefly, and without a lot of editing or crafting, by imagining that I'm speaking to someone in software development who's acting in good faith, cares about their work and mine, but doesn't have much visibility of what testing can be. Perhaps you'd like to join me?   --00-- "When the build is green, the product is of sufficient quality to release" An interesting take, and one I wouldn't agree with in general. That surprises you? Well, ho

Make, Fix, and Test

A few weeks ago, in A Good Tester is All Over the Place , Joep Schuurkes described a model of testing work based on three axes: do testing yourself or support testing by others be embedded in a team or be part of a separate team do your job or improve the system It resonated with me and the other testers I shared it with at work, and it resurfaced in my mind while I was reflecting on some of the tasks I've picked up recently and what they have involved, at least in the way I've chosen to address them. Here's three examples: Documentation Generation We have an internal tool that generates documentation in Confluence by extracting and combining images and text from a handful of sources. Although useful, it ran very slowly or not at all so one of the developers performed major surgery on it. Up to that point, I had never taken much interest in the tool and I could have safely ignored this piece of work too because it would have been tested by

Test Now

The Association for Software Testing is crowd-sourcing a book,  Navigating the World as a Context-Driven Tester , which aims to provide  responses to common questions and statements about testing from a  context-driven perspective . It's being edited by  Lee Hawkins  who is  posing questions on  Twitter ,   LinkedIn , Mastodon , Slack , and the AST  mailing list  and then collating the replies, focusing on practice over theory. I've decided to  contribute  by answering briefly, and without a lot of editing or crafting, by imagining that I'm speaking to someone in software development who's acting in good faith, cares about their work and mine, but doesn't have much visibility of what testing can be. Perhaps you'd like to join me?   --00-- "When is the best time to test?" Twenty posts in , I hope you're not expecting an answer without nuance? You are? Well, I'll do my best. For me, the best time to test is when there

Vanilla Flavour Testing

I have been pairing with a new developer colleague recently. In our last session he asked me "is this normal testing?" saying that he'd never seen anything like it anywhere else that he'd worked. We finished the task we were on and then chatted about his question for a few minutes. This is a short summary of what I said. I would describe myself as context-driven . I don't take the same approach to testing every time, except in a meta way. I try to understand the important questions, who they are important to, and what the constraints on the work are. With that knowledge I look for productive, pragmatic, ways to explore whatever we're looking at to uncover valuable information or find a way to move on. I write test notes as I work in a format that I have found to be useful to me, colleagues, and stakeholders. For me, the notes should clearly state the mission and give a tl;dr summary of the findings and I like them to be public while I'm working not just w

Am I Wrong?

I happened across Exploratory Testing: Why Is It Not Ideal for Agile Projects? by Vitaly Prus this week and I was triggered. But why? I took a few minutes to think that through. Partly, I guess, I feel directly challenged. I work on an agile project (by the definition in the article) and I would say that I use exclusively exploratory testing. Naturally, I like to think I'm doing a good job. Am I wrong? After calming down, and re-reading the article a couple of times, I don't think so. 😸 From the start, even the title makes me tense. The ideal solution is a perfect solution, the best solution. My context-driven instincts are reluctant to accept the premise, and I wonder what the author thinks is an ideal solution for an agile project, or any project. I notice also that I slid so easily from "an approach is not ideal" into "I am not doing a good job" and, in retrospect, that makes me smile. It doesn't do any harm to be reminded that your cognitive bias