Add ability to output build time

Author: oschwald

CHANGELOG.md

@@ -16,8 +16,11 @@
   matches, it will be treated as if multiple `-db` arguments were provided.
   Note that you must quote the parameter when using globs to prevent the
   shell's globbing from interfering. See the [pattern syntax](https://pkg.go.dev/path#Match)
-* You may now include networks with no data in the output by using the
-  `include-networks-without-data` flag.
+* The following flags were added:
+  * `-include-networks-without-data` - include networks without any data in
+    the database in the output.
+  * `-include-build-time` - include the build time from the database's
+    metadata in the output.
 * This repo no longer provides a public Go API. It is only intended to be
   used as a CLI program.
 

cmd/mmdbinspect/main.go

@@ -35,6 +35,12 @@ func main() {
 		"Include aliased networks (e.g. 6to4, Teredo). This option may cause IPv4 networks to be listed more than once via aliases.", //nolint: lll
 	)
 
+	includeBuildTime := flag.Bool(
+		"include-build-time",
+		false,
+		"Include the build time of the database in the output.",
+	)
+
 	includeNetworksWithoutData := flag.Bool(
 		"include-networks-without-data",
 		false,
@@ -78,6 +84,7 @@ func main() {
 		network,
 		mmdb,
 		*includeAliasedNetworks,
+		*includeBuildTime,
 		*includeNetworksWithoutData,
 	)
 

cmd/mmdbinspect/mmdbinspect.go

@@ -9,13 +9,16 @@ import (
 	"os"
 	"path/filepath"
 	"strings"
+	"time"
 
 	"github.com/oschwald/maxminddb-golang/v2"
 )
 
-// record holds the records for a lookup in a database.
+// record holds the records for a lookup in a database. Note that
+// the order here affects the output order
 type record struct {
 	DatabasePath    string       `json:"database_path"`
+	BuildTime       *time.Time   `json:"build_time,omitempty"`
 	RequestedLookup string       `json:"requested_lookup"`
 	Network         netip.Prefix `json:"network"`
 	Record          any          `json:"record,omitempty"`
@@ -26,6 +29,7 @@ type record struct {
 func records(
 	networks, databases []string,
 	includeAliasedNetworks,
+	includeBuildTime,
 	includeNetworksWithoutData bool,
 ) iter.Seq2[*record, error] {
 	var opts []maxminddb.NetworksOption
@@ -50,9 +54,16 @@ func records(
 					return
 				}
 
+				var buildTime *time.Time
+				if includeBuildTime {
+					t := time.Unix(int64(reader.Metadata.BuildEpoch), 0).UTC()
+					buildTime = &t
+				}
+
 				for _, thisNetwork := range networks {
 					baseRecord := record{
 						DatabasePath:    path,
+						BuildTime:       buildTime,
 						RequestedLookup: thisNetwork,
 					}
 					ok := recordsForNetwork(reader, opts, baseRecord, yield)

cmd/mmdbinspect/mmdbinspect_test.go

@@ -4,6 +4,7 @@ import (
 	"net/netip"
 	"path/filepath"
 	"testing"
+	"time"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
@@ -140,10 +141,13 @@ var country81_2_69_142 = map[string]any{
 }
 
 func TestRecords(t *testing.T) {
+	countryBuildTime := time.Date(2019, 11, 4, 16, 30, 59, 0, time.UTC)
+
 	tests := []struct {
 		name                       string
 		dbs                        []string
 		networks                   []string
+		includeBuildTime           bool
 		includeNetworksWithoutData bool
 		expectRecords              []record
 		expectErr                  string
@@ -167,6 +171,21 @@ func TestRecords(t *testing.T) {
 				},
 			},
 		},
+		{
+			name:             "with build time",
+			dbs:              []string{CountryDBPath},
+			networks:         []string{"81.2.69.142"},
+			includeBuildTime: true,
+			expectRecords: []record{
+				{
+					DatabasePath:    CountryDBPath,
+					BuildTime:       &countryBuildTime,
+					RequestedLookup: "81.2.69.142",
+					Network:         netip.MustParsePrefix("81.2.69.142/31"),
+					Record:          country81_2_69_142,
+				},
+			},
+		},
 		{
 			name:     "glob path",
 			dbs:      []string{filepath.Join(testDataDir, "GeoIP2-C*y-Test.mmdb")},
@@ -227,7 +246,7 @@ func TestRecords(t *testing.T) {
 	for _, test := range tests {
 		t.Run(test.name, func(t *testing.T) {
 			var recs []record
-			for record, err := range records(test.networks, test.dbs, false, test.includeNetworksWithoutData) {
+			for record, err := range records(test.networks, test.dbs, false, test.includeBuildTime, test.includeNetworksWithoutData) {
 				// For now, we don't test errors that happen half way through an
 				// iteration. If we want to in the future, we will need to rework
 				// this a bit.