Merge ~utkarsh/ubuntu/+source/at:lp1677748-add-dep8-tests into ubuntu/+source/at:ubuntu/devel

[Utkarsh Gupta]

Hello,

This MP adds a DEP8 test for the at package, using and for at and atq functionalities.

This is a trivial but good test to catch regressions, if there's any. I also intend to send this to Debian hopefully after this is merged here and uploaded.

PPA at https://launchpad.net/~utkarsh/+archive/ubuntu/experimental-dump.

Autopkgtest is clean and happy as well:
```
autopkgtest [02:20:37]: test basic-usage: -----------------------]
autopkgtest [02:20:37]: test basic-usage: - - - - - - - - - - results - - - - - - - - - -
basic-usage PASS
autopkgtest [02:20:38]: @@@@@@@@@@@@@@@@@@@@ summary
```

Requesting y'all to please review and sponsor the upload. TIA!

[Bryce Harrington (bryce)]

* Changelog:
  - [-] old content and logical tag match as expected
  - [√] changelog entry correct version and targeted codename
  - [√] changelog entries correct
  - [-] update-maintainer has been run

* Actual changes:
  - [-] no upstream changes to consider
  - [-] no further upstream version to consider
  - [√] debian changes look safe

* Old Delta:
  - [-] dropped changes are ok to be dropped
  - [-] nothing else to drop
  - [√] changes forwarded upstream/debian (if appropriate)
    + (Yes, mp indicates will be forwarded subsequently)

* New Delta:
  - [√] no new patches added
  - [-] patches match what was proposed upstream
  - [-] patches correctly included in debian/patches/series
  - [-] patches have correct DEP3 metadata

* Build/Test:
  - [√] build is ok
  - [√] verified PPA package installs/uninstalls
  - [√] autopkgtest against the PPA package passes
  - [√] sanity checks test fine

Some review comments inline below. Most are suggestions and you can take or not as you wish, the only actual coding error is the '-eq' -> '=' one.

DEP8 passes for autopkgtest when run with an ephemeral container, however I did find a situation where it will fail to pass (see below).

review: Needs Fixing

[Bryce Harrington (bryce)]

Hmm, launchpad didn't save my code comments for some reason. That's annoying...

[Bryce Harrington (bryce)]

I've redone the comments, let's see if they save this time.

[Utkarsh Gupta (utkarsh)]

Hi Bryce,

Thanks for the great review. I've adjusted the MP according to the suggestions proposed. The only bit remaining is "skipping error checking in favor of set -ex". I'd personally like explicit checks (as do you) because it really helps in debugging and reading through as to what it was supposed to do v/s what's happening.

Whilst this is a trivial test and it's easier to figure out this but in more complex cases, I'd personally use them to be explicitly explicit.

I'm OK in removing those as well if that's still preferable and if you'd like me to do so. Please let me know! \o/

[Bryce Harrington (bryce)]

LGTM, +1

And yeah like mentioned while there are common conventions there is lots of room for personal style preferences.

review: Approve

[Bryce Harrington (bryce)]

Upload sponsored:

$ dput ubuntu ../at_3.1.23-1.1ubuntu3_source.changes
D: Setting host argument.
Checking signature on .changes
gpg: ../at_3.1.23-1.1ubuntu3_source.changes: Valid signature from E603B2578FB8F0FB
Checking signature on .dsc
gpg: ../at_3.1.23-1.1ubuntu3.dsc: Valid signature from E603B2578FB8F0FB
Uploading to ubuntu (via ftp to upload.ubuntu.com):
  Uploading at_3.1.23-1.1ubuntu3.dsc: done.
  Uploading at_3.1.23-1.1ubuntu3.debian.tar.xz: done.
  Uploading at_3.1.23-1.1ubuntu3_source.buildinfo: done.
  Uploading at_3.1.23-1.1ubuntu3_source.changes: done.
Successfully uploaded packages.
$ git ubuntu tag --upload
$ git push pkg upload/3.1.23-1.1ubuntu3
Enumerating objects: 14, done.
Counting objects: 100% (14/14), done.
Delta compression using up to 12 threads
Compressing objects: 100% (11/11), done.
Writing objects: 100% (11/11), 1.93 KiB | 197.00 KiB/s, done.
Total 11 (delta 5), reused 0 (delta 0), pack-reused 0
To ssh://git.launchpad.net/ubuntu/+source/at
 * [new tag] upload/3.1.23-1.1ubuntu3 -> upload/3.1.23-1.1ubuntu3

diff --git a/debian/changelog b/debian/changelog
index 09ff2a6..c5afc6c 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -1,3 +1,10 @@
+at (3.1.23-1.1ubuntu3) hirsute; urgency=medium
+
+  * d/t/{control, basic-usage}: Add DEP8 test
+    for testing basic usage of at and atq commands. (LP: #1677748)
+
+ -- Utkarsh Gupta <[e-mail]>  Tue, 16 Mar 2021 18:27:13 +0530
+
 at (3.1.23-1.1ubuntu2) hirsute; urgency=medium
 
   * d/patches: add 03-do-not-drop-seconds.patch (cherry-pick).
diff --git a/debian/tests/basic-usage b/debian/tests/basic-usage
 new file mode 100755
index 0000000..7f3eb4c
--- /dev/null
+++ b/debian/tests/basic-usage
@@ -0,0 +1,61 @@
+#!/bin/bash
+
+#################################################
+##                                             ##
+## Basic usage of `at` to create a file and    ##
+## also take in account the queue, using atq.  ##
+##                                             ##
+## Written by:                                 ##
+## Utkarsh Gupta <[e-mail]> ##
+## License: GPL-2+                             ##
+##                                             ##
+#################################################
+
+set -ex
+
+TMPFILE=at.$RANDOM
+WORKDIR=$(mktemp -d)
+trap "rm -rf $WORKDIR" 0 INT QUIT ABRT PIPE TERM
+
+JOBS_BEFORE=$(atq | wc -l)
+
+# use at command to schedule a job.
+echo "echo `date` > ${WORKDIR}/${TMPFILE}" | at now + 1 minute
+
+sleep 2
+
+# check if the file is created at the wrong
+# time, that is, 58 seconds earlier.
+if test -f "$TMPFILE"
+then
+  echo "$TMPFILE already exits but it really shouldn't."
+  exit 1
+else
+  echo "OK, $TMPFILE doesn't exist yet; expected.."
+fi
+
+# check atq to see the queued jobs.
+# there should be a one new job.
+JOBS_AFTER=$(atq | wc -l)
+
+if [[ $((JOBS_AFTER - JOBS_BEFORE)) -eq 1 ]]
+then
+  echo "OK, 1 new queued job exists.."
+else
+  echo "No new queued job found."
+  exit 1
+fi
+
+sleep 58
+
+# grep the content of the file to verify that
+# everything is in order.
+if grep -Fq "UTC" $WORKDIR/$TMPFILE
+then
+  echo "OK, $TMPFILE exists and everything looks in order.."
+else
+  echo "Either $TMPFILE doesn't exist or the content differs."
+  exit 1
+fi
+
+echo "OK; PASS."
diff --git a/debian/tests/control b/debian/tests/control
 new file mode 100644
index 0000000..ccc00c6
--- /dev/null
+++ b/debian/tests/control
@@ -0,0 +1,3 @@
+Tests: basic-usage
+Depends: @
+Restrictions: allow-stderr