update sdk to support more products

fix doc errors
update tests
add manifest example and know issues to readme

Author: laidbackware

.github/workflows/tests.yml

@@ -23,7 +23,7 @@ jobs:
       uses: actions/checkout@v2
 
     - name: Run Golang Tests
-      run: go test -v ./...
+      run: go test -v ./... | go test -v ./...
 
     - name: Setup BATS
       if: runner.os != 'windows'

README.md

@@ -15,7 +15,7 @@ To make it available to all users `sudo mv vmd-<os>-<version> /usr/local/bin/vmd
   vmd download -p vmware_tools -s vmtools -v 11.* -f VMware-Tools-darwin-*.zip --accepteula
 
   # Download files using a manifest file
-  vmd download -m manifest.yml --accepteula
+  vmd download -m <filename>.yml --accepteula
 
   # List of available products
   vmd get products
@@ -32,8 +32,34 @@ To make it available to all users `sudo mv vmd-<os>-<version> /usr/local/bin/vmd
   # Display example manifest file
   vmd get manifestexample
 ```
+Example manifest to use with `vmd download -m <filename>.yml`
+```
+---
+# This section will download the latest version of vmware_tools
+# Each glob pattern will download a single file each
+product: vmware_tools
+subproduct: vmtools
+version: "*"
+filename_globs:
+        - "VMware-Tools-darwin-*.tar.gz"
+        - "VMware-Tools-darwin-*.zip"
+---
+# This section will download the latest minor release from major version 10
+# The single glob pattern will download 2 files
+product: vmware_tools
+subproduct: vmtools
+version: "10.*"
+filename_globs:
+        - "VMware-Tools-other-*"
+---
+```
+# Known Issues
+- When working in a shell if you add a * to the filename arguement of the download command and you are in a directory where a file matches the pattern, your shell will replace the * to pass in the full file name. This can be worked around by wrapping the file name in single quotes, or by defining the download in a manifest yaml.
+- Some products such as horizon will not return the latest version when only a glob is provided. This is because the product switched naming standards meaning it breaks the sort of the version.
+- Some product descriptions don't display fully. This is especially true for the horizon products as they are inconsistently named, meaning it's difficult to extract the version number without taking out part of the product name.
+
 # Testing
-To run commands against source use `alias vmd="go run main.go`</br>
+To run commands against source use `alias vmd="go run main.go"`</br>
 Run go tests `go test ./...`</br>
 Run BATS tests `bats test/bats`
 

api/subproducts.go

@@ -8,7 +8,7 @@ import (
 )
 
 func ListSubProducts(slug string) (data [][]string, err error) {
-	var subProducts []sdk.SubProduct
+	var subProducts []sdk.SubProductDetails
 	subProducts, err = basicClient.GetSubProductsSlice(slug)
 	if err != nil {return}
 	for _, v := range subProducts {

cmd/docs.go

@@ -18,9 +18,11 @@ const (
   vmd get manifestexample`
 
 	downloadUsage = `  # Download the latest version of release 11 with a file matching the pattern
-  vmd download -p vmware_tools -s vmtools -v 11.* -f VMware-Tools-darwin-*.zip --accepteula
+# If using a * in the filename value, make sure to wrap the text in single quotes on linux/macos
+  vmd download -p vmware_tools -s vmtools -v 11.* -f 'VMware-Tools-darwin-*.zip' --accepteula
 
   # Download files using a manifest file
+# Show an example manifest using 'vmd get manifestexample'
   vmd download -m manifest.yml --accepteula`
 )
 

cmd/download.go

@@ -109,7 +109,7 @@ func init() {
 	downloadCmd.Flags().StringVarP(&slug, "product", "p", "", "Product code")
 	downloadCmd.Flags().StringVarP(&subProduct, "subproduct", "s", "", "Sub Product code")
 	downloadCmd.Flags().StringVarP(&version, "version", "v", "", "Version string. Can contain a glob.")
-	downloadCmd.Flags().StringVarP(&fileName, "filename", "f", "", "Filename string. Can contain one or more globs.")
+	downloadCmd.Flags().StringVarP(&fileName, "filename", "f", "", "Filename string. Can contain one or more globs. When using * wrap the text in single quotes.")
 	downloadCmd.Flags().StringVarP(&manifestFile, "manifest", "m", "", "Filename of the manifest containing details of what to download")
 	downloadCmd.Flags().StringVarP(&outputDir, "output", "o", "", "Directory to download files to")
 	downloadCmd.Flags().BoolVarP(&acceptEula, "accepteula", "a", false, "Filename string")

cmd/products.go

@@ -37,7 +37,7 @@ var productsCmd = &cobra.Command{
 		if err != nil {
 			handleErrors(err)
 		}
-		headings := []string{"Product code", "Produce description"}
+		headings := []string{"Product code", "Product description"}
 		presenters.RenderTable(headings, products)
 	},
 }

go.mod

@@ -6,7 +6,7 @@ require (
 	github.com/dustin/go-humanize v1.0.0
 	github.com/google/go-cmp v0.5.6 // indirect
 	github.com/kr/pretty v0.2.0 // indirect
-	github.com/laidbackware/vmware-download-sdk v0.0.0-20211004152325-e1b7eb16c537
+	github.com/laidbackware/vmware-download-sdk v0.0.0-20211103135845-0c774de1d62d
 	github.com/olekukonko/tablewriter v0.0.5
 	github.com/orirawlings/persistent-cookiejar v0.3.0
 	github.com/spf13/cobra v1.2.1

go.sum

@@ -235,6 +235,8 @@ github.com/laidbackware/vmware-download-sdk v0.0.0-20211003124744-407b61b8f026 h
 github.com/laidbackware/vmware-download-sdk v0.0.0-20211003124744-407b61b8f026/go.mod h1:oXUINbShbZy4/y7OMIjyhjMPYzvVFg5QvRq8Dck7s1U=
 github.com/laidbackware/vmware-download-sdk v0.0.0-20211004152325-e1b7eb16c537 h1:KidmypR1GRG/G+Hl9pUUtO9jj/UrL5edt/n2dmbXvtQ=
 github.com/laidbackware/vmware-download-sdk v0.0.0-20211004152325-e1b7eb16c537/go.mod h1:oXUINbShbZy4/y7OMIjyhjMPYzvVFg5QvRq8Dck7s1U=
+github.com/laidbackware/vmware-download-sdk v0.0.0-20211103135845-0c774de1d62d h1:R5Ya5p5lYg0ZdfN8mSLOuXa04WDRTjbX6A53+oSpehA=
+github.com/laidbackware/vmware-download-sdk v0.0.0-20211103135845-0c774de1d62d/go.mod h1:oXUINbShbZy4/y7OMIjyhjMPYzvVFg5QvRq8Dck7s1U=
 github.com/magiconair/properties v1.8.5 h1:b6kJs+EmPFMYGkow9GiUyCyOvIwYetYJ3fSaWak/Gls=
 github.com/magiconair/properties v1.8.5/go.mod h1:y3VJvCyxH9uVvJTWEGAELF3aiYNyPKd5NZ3oSwXrF60=
 github.com/mattn/go-colorable v0.0.9/go.mod h1:9vuHe8Xs5qXnSaW/c/ABM9alt+Vo+STaOChaDxuIBZU=

test/bats/download.bats

@@ -10,14 +10,15 @@ setup() {
 }
 
 teardown() {
-  # rm -rf "${TEMP_DIR}"
+  rm -rf "${TEMP_DIR}"
+  rm $HOME/vmd-downloads/VMware-Tools-darwin-11.3.0-*.zip
   echo ""
 }
 
 @test "download single file successfully to temp" {
   $VMD_CMD logout
   rm -f $TEMP_DIR/*
-  local cmd="$VMD_CMD download -p vmware_tools -s vmtools -v 11.3.0 -f VMware-Tools-darwin-*.zip --accepteula -o $TEMP_DIR"
+  local cmd="$VMD_CMD download -p vmware_horizon_clients -s cart+andrd_x8632 -v 2106 -f VMware-Horizon-Client-AndroidOS-x86-*-store.apk --accepteula -o $TEMP_DIR"
   echo $cmd
   run $cmd
   echo $output
@@ -26,7 +27,7 @@ teardown() {
   [[ "$output" == *"Download started to"* ]]
   [[ "$output" == *"Download finished"* ]]
   [ "$status" -eq 0 ]
-  [ -f $TEMP_DIR/VMware-Tools-darwin-*.zip ]
+  [ -f $TEMP_DIR/VMware-Horizon-Client-*.apk ]
 }
 
 @test "download single file successfully to user vmd-downloads" {