File: testsuite.go

package info (click to toggle)
golang-github-crc-org-crc 2.34.0%2Bds1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,548 kB
  • sloc: sh: 398; makefile: 326; javascript: 40
file content (1063 lines) | stat: -rw-r--r-- 32,412 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
package testsuite

import (
	"context"
	"crypto/tls"
	"fmt"
	"net/http"
	"os"
	"os/user"
	"path/filepath"
	"runtime"
	"strings"
	"time"

	"github.com/crc-org/crc/v2/pkg/crc/constants"
	"github.com/crc-org/crc/v2/pkg/crc/preset"
	"github.com/crc-org/crc/v2/pkg/crc/version"
	"github.com/crc-org/crc/v2/test/extended/crc/cmd"
	crcCmd "github.com/crc-org/crc/v2/test/extended/crc/cmd"
	"github.com/crc-org/crc/v2/test/extended/util"
	"github.com/cucumber/godog"
	"github.com/spf13/pflag"
)

var (
	CRCExecutable      string
	userProvidedBundle bool
	bundleName         string
	bundleLocation     string
	pullSecretFile     string
	cleanupHome        bool
	testWithShell      string
	CRCVersion         string
	CRCMemory          string

	GodogTags string
)

func defaultCRCVersion() string {
	return fmt.Sprintf("%s+%s", version.GetCRCVersion(), version.GetCommitSha())
}

func ParseFlags() {

	pflag.StringVar(&util.TestDir, "test-dir", "out", "Path to the directory in which to execute the tests")
	pflag.StringVar(&testWithShell, "test-shell", "", "Specifies shell to be used for the testing.")

	pflag.StringVar(&bundleLocation, "bundle-location", "", "Path to the bundle to be used in tests")
	pflag.StringVar(&pullSecretFile, "pull-secret-file", "/path/to/pull-secret", "Path to the file containing pull secret")
	pflag.StringVar(&CRCExecutable, "crc-binary", "", "Path to the CRC executable to be tested")
	pflag.BoolVar(&cleanupHome, "cleanup-home", false, "Try to remove crc home folder before starting the suite") // TODO: default=true
	pflag.StringVar(&CRCVersion, "crc-version", defaultCRCVersion(), "Version of CRC to be tested")
	pflag.StringVar(&CRCMemory, "crc-memory", "", "Memory for CRC VM in MiB")
}

func InitializeTestSuite(tctx *godog.TestSuiteContext) {

	tctx.BeforeSuite(func() {

		err := util.PrepareForE2eTest()
		if err != nil {
			fmt.Println(err)
			os.Exit(1)
		}

		usr, _ := user.Current()
		util.CRCHome = filepath.Join(usr.HomeDir, ".crc")

		// init CRCExecutable if no location provided by user
		if CRCExecutable == "" {
			fmt.Println("Expecting the CRC executable to be in $HOME/go/bin.")
			usr, _ := user.Current()
			CRCExecutable = filepath.Join(usr.HomeDir, "go", "bin")
		}

		// Force debug logs
		err = os.Setenv("CRC_LOG_LEVEL", "debug")
		if err != nil {
			fmt.Println("Could not set `CRC_LOG_LEVEL` to `debug`:", err)
		}

		// put CRC executable location on top of PATH
		path := os.Getenv("PATH")
		newPath := fmt.Sprintf("%s%c%s", CRCExecutable, os.PathListSeparator, path)
		err = os.Setenv("PATH", newPath)
		if err != nil {
			fmt.Println("Could not put CRC location on top of PATH")
			os.Exit(1)
		}

		// If we are running the tests against an existing, already
		// running cluster, we don't need a bundle nor a pull secret,
		// and we don't want to remove ~/.crc, so bail out early.
		if usingPreexistingCluster() {
			return
		}

		if bundleLocation == "" {
			userProvidedBundle = false
			bundleName = constants.GetDefaultBundle(preset.OpenShift)
		} else {
			fmt.Println("Expecting the bundle provided by the user")
			userProvidedBundle = true
			_, bundleName = filepath.Split(bundleLocation)
		}

		if pullSecretFile == "" {
			fmt.Println("User must specify the pull secret file via --pull-secret-file flag.")
			os.Exit(1)
		}

		if cleanupHome {
			// remove $HOME/.crc
			err = util.RemoveCRCHome()
			if err != nil {
				fmt.Println(err)
				os.Exit(1)
			}
		}

		if userProvidedBundle {
			if _, err := os.Stat(bundleLocation); err != nil {
				if !os.IsNotExist(err) {
					fmt.Printf("Unexpected error obtaining the bundle %v.\n", bundleLocation)
					os.Exit(1)
				}
				// Obtain the bundle to current dir
				fmt.Println("Obtaining bundle...")
				bundleLocation, err = util.DownloadBundle(bundleLocation, ".", bundleName)
				if err != nil {
					fmt.Printf("Failed to obtain CRC bundle, %v\n", err)
					os.Exit(1)
				}
				fmt.Println("Using bundle:", bundleLocation)
			} else {
				fmt.Println("Using existing bundle:", bundleLocation)
			}
		}
	})

	tctx.AfterSuite(func() {

		err := crcCmd.DeleteCRC()
		if err != nil {
			fmt.Printf("Could not delete CRC VM: %s.", err)
		}

		err = util.LogMessage("info", "----- Cleaning Up -----")
		if err != nil {
			fmt.Println("error logging:", err)
		}

		err = util.CloseLog()
		if err != nil {
			fmt.Println("Error closing the log:", err)
		}
	})
}

func InitializeScenario(s *godog.ScenarioContext) {

	s.Before(func(ctx context.Context, sc *godog.Scenario) (context.Context, error) {

		err := util.StartHostShellInstance(testWithShell)
		if err != nil {
			fmt.Println("error starting host shell instance:", err)
		}
		util.ClearScenarioVariables()

		err = util.CleanTestRunDir()
		if err != nil {
			fmt.Println(err)
			os.Exit(1)
		}

		err = util.LogMessage("info", fmt.Sprintf("----- Scenario: %s -----", sc.Name))
		if err != nil {
			fmt.Println("error logging:", err)
		}
		err = util.LogMessage("info", fmt.Sprintf("----- Scenario Outline: %s -----", sc.Name))
		if err != nil {
			fmt.Println("error logging:", err)
		}

		for _, tag := range sc.Tags {

			// if podman preset is activated, bundle will not be provided by the user
			if tag.Name == "@podman-preset" {
				userProvidedBundle = false
			}

			// copy data/config files to test dir
			if tag.Name == "@testdata" {
				err := util.CopyFilesToTestDir()
				if err != nil {
					os.Exit(1)
				}
			}

			// move host's date 13 months forward and turn timesync off
			if tag.Name == "@timesync" {
				err := util.ExecuteCommand("sudo timedatectl set-ntp off")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
				err = util.ExecuteCommand("sudo date -s '13 month'")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
				err = util.ExecuteCommandWithRetry(10, "1s", "virsh --readonly -c qemu:///system capabilities", "contains", "<capabilities>")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
			}

			if tag.Name == "@proxy" {

				// start container with squid proxy
				err := util.ExecuteCommand("podman run --name squid -d -p 3128:3128 quay.io/crcont/squid")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = util.ExecuteCommand("crc config set http-proxy http://192.168.130.1:3128")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = util.ExecuteCommand("crc config set https-proxy http://192.168.130.1:3128")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = util.ExecuteCommand("crc config set no-proxy .testing")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

			}
		}

		return ctx, nil
	})

	s.After(func(ctx context.Context, sc *godog.Scenario, err error) (context.Context, error) {

		for _, tag := range sc.Tags {

			// delete testproj namespace after a Scenario that used it
			if tag.Name == "@needs_namespace" {
				err := util.ExecuteCommand("oc delete namespace testproj")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
			}

			// move host's date 13 months back and turn timesync on
			if tag.Name == "@timesync" {
				err := util.ExecuteCommand("sudo date -s '-13 month'")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
				err = util.ExecuteCommand("sudo timedatectl set-ntp on")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
			}

			if tag.Name == "@cleanup" {

				// CRC instance cleanup
				err := util.ExecuteCommand("crc cleanup")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				// CRC config cleanup
				err = crcCmd.UnsetConfigPropertySucceedsOrFails("enable-cluster-monitoring", "succeeds") // unsetting property that is not set gives 0 exitcode, so this works
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = crcCmd.UnsetConfigPropertySucceedsOrFails("memory", "succeeds") // unsetting property that is not set gives 0 exitcode, so this works
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = crcCmd.UnsetConfigPropertySucceedsOrFails("preset", "succeeds") // unsetting property that is not set gives 0 exitcode, so this works
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
			}

			if tag.Name == "@proxy" {

				err := util.ExecuteCommand("podman stop squid")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = util.ExecuteCommand("podman rm squid")
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = crcCmd.UnsetConfigPropertySucceedsOrFails("http-proxy", "succeeds") // unsetting property that is not set gives 0 exitcode, so this works
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = crcCmd.UnsetConfigPropertySucceedsOrFails("https-proxy", "succeeds") // unsetting property that is not set gives 0 exitcode, so this works
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				err = crcCmd.UnsetConfigPropertySucceedsOrFails("no-proxy", "succeeds") // unsetting property that is not set gives 0 exitcode, so this works
				if err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				// crc oc-env sets these three quietly if http(s)-proxy is set in crc config
				if err := os.Unsetenv("HTTP_PROXY"); err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				if err := os.Unsetenv("HTTPS_PROXY"); err != nil {
					fmt.Println(err)
					os.Exit(1)
				}

				if err := os.Unsetenv("NO_PROXY"); err != nil {
					fmt.Println(err)
					os.Exit(1)
				}
			}

		}

		return ctx, nil
	})

	s.StepContext().Before(func(ctx context.Context, st *godog.Step) (context.Context, error) {
		st.Text = util.ProcessScenarioVariables(st.Text)
		return ctx, nil
	})

	// Executing commands
	s.Step(`^executing "(.*)"$`,
		util.ExecuteCommand)
	s.Step(`^executing "(.*)" (succeeds|fails)$`,
		util.ExecuteCommandSucceedsOrFails)

	// Command output verification
	s.Step(`^(stdout|stderr|exitcode) (?:should contain|contains) "(.*)"$`,
		util.CommandReturnShouldContain)
	s.Step(`^(stdout|stderr|exitcode) (?:should contain|contains)$`,
		util.CommandReturnShouldContainContent)
	s.Step(`^(stdout|stderr|exitcode) (?:should|does) not contain "(.*)"$`,
		util.CommandReturnShouldNotContain)
	s.Step(`^(stdout|stderr|exitcode) (?:should|does not) contain$`,
		util.CommandReturnShouldNotContainContent)
	s.Step(`^(stdout|stderr|exitcode) (?:should contain|contains) correct version$`,
		CommandReturnShouldContainCorrectVersion)

	s.Step(`^(stdout|stderr|exitcode) (?:should equal|equals) "(.*)"$`,
		util.CommandReturnShouldEqual)
	s.Step(`^(stdout|stderr|exitcode) (?:should equal|equals)$`,
		util.CommandReturnShouldEqualContent)
	s.Step(`^(stdout|stderr|exitcode) (?:should|does) not equal "(.*)"$`,
		util.CommandReturnShouldNotEqual)
	s.Step(`^(stdout|stderr|exitcode) (?:should|does) not equal$`,
		util.CommandReturnShouldNotEqualContent)

	s.Step(`^(stdout|stderr|exitcode) (?:should match|matches) "(.*)"$`,
		util.CommandReturnShouldMatch)
	s.Step(`^(stdout|stderr|exitcode) (?:should match|matches)`,
		util.CommandReturnShouldMatchContent)
	s.Step(`^(stdout|stderr|exitcode) (?:should|does) not match "(.*)"$`,
		util.CommandReturnShouldNotMatch)
	s.Step(`^(stdout|stderr|exitcode) (?:should|does) not match`,
		util.CommandReturnShouldNotMatchContent)

	s.Step(`^(stdout|stderr|exitcode) (?:should be|is) empty$`,
		util.CommandReturnShouldBeEmpty)
	s.Step(`^(stdout|stderr|exitcode) (?:should not be|is not) empty$`,
		util.CommandReturnShouldNotBeEmpty)

	s.Step(`^(stdout|stderr|exitcode) (?:should be|is) valid "([^"]*)"$`,
		util.ShouldBeInValidFormat)

	// Command output and execution: extra steps
	s.Step(`^with up to "(\d*)" retries with wait period of "(\d*(?:ms|s|m))" command "(.*)" output (should contain|contains|should not contain|does not contain) "(.*)"$`,
		util.ExecuteCommandWithRetry)
	s.Step(`^evaluating stdout of the previous command succeeds$`,
		util.ExecuteStdoutLineByLine)

	// Scenario variables
	// allows to set a scenario variable to the output values of minishift and oc commands
	// and then refer to it by $(NAME_OF_VARIABLE) directly in the text of feature file
	s.Step(`^setting scenario variable "(.*)" to the stdout from executing "(.*)"$`,
		util.SetScenarioVariableExecutingCommand)

	// Filesystem operations
	s.Step(`^creating directory "([^"]*)" succeeds$`,
		util.CreateDirectory)
	s.Step(`^creating file "([^"]*)" succeeds$`,
		util.CreateFile)
	s.Step(`^deleting directory "([^"]*)" succeeds$`,
		util.DeleteDirectory)
	s.Step(`^deleting file "([^"]*)" succeeds$`,
		util.DeleteFile)
	s.Step(`^directory "([^"]*)" should not exist$`,
		util.DirectoryShouldNotExist)
	s.Step(`^file "([^"]*)" should not exist$`,
		util.FileShouldNotExist)
	s.Step(`^file "([^"]*)" exists$`,
		util.FileExist)
	s.Step(`^file from "(.*)" is downloaded into location "(.*)"$`,
		util.DownloadFileIntoLocation)
	s.Step(`^writing text "([^"]*)" to file "([^"]*)" succeeds$`,
		util.WriteToFile)
	s.Step(`^removing (podman|openshift) bundle from cache succeeds$`,
		RemoveBundleFromCache)

	// File content checks
	s.Step(`^content of file "([^"]*)" should contain "([^"]*)"$`,
		util.FileContentShouldContain)
	s.Step(`^content of file "([^"]*)" should not contain "([^"]*)"$`,
		util.FileContentShouldNotContain)
	s.Step(`^content of file "([^"]*)" should equal "([^"]*)"$`,
		util.FileContentShouldEqual)
	s.Step(`^content of file "([^"]*)" should not equal "([^"]*)"$`,
		util.FileContentShouldNotEqual)
	s.Step(`^content of file "([^"]*)" should match "([^"]*)"$`,
		util.FileContentShouldMatchRegex)
	s.Step(`^content of file "([^"]*)" should not match "([^"]*)"$`,
		util.FileContentShouldNotMatchRegex)
	s.Step(`^content of file "([^"]*)" (?:should be|is) valid "([^"]*)"$`,
		util.FileContentIsInValidFormat)

	// Config file content, JSON and YAML
	s.Step(`"(JSON|YAML)" config file "(.*)" (contains|does not contain) key "(.*)" with value matching "(.*)"$`,
		util.ConfigFileContainsKeyMatchingValue)
	s.Step(`"(JSON|YAML)" config file "(.*)" (contains|does not contain) key "(.*)"$`,
		util.ConfigFileContainsKey)

	// CRC related steps
	s.Step(`^removing CRC home directory succeeds$`,
		util.RemoveCRCHome)
	s.Step(`^starting CRC with default bundle (succeeds|fails)$`,
		StartCRCWithDefaultBundleSucceedsOrFails)
	s.Step(`^starting CRC with custom bundle (succeeds|fails)$`,
		StartCRCWithCustomBundleSucceedsOrFails)
	s.Step(`^starting CRC with default bundle along with stopped network time synchronization (succeeds|fails)$`,
		StartCRCWithDefaultBundleWithStopNetworkTimeSynchronizationSucceedsOrFails)
	s.Step(`^starting CRC with default bundle and nameserver "(.*)" (succeeds|fails)$`,
		StartCRCWithDefaultBundleAndNameServerSucceedsOrFails)
	s.Step(`^setting config property "(.*)" to value "(.*)" (succeeds|fails)$`,
		SetConfigPropertyToValueSucceedsOrFails)
	s.Step(`^unsetting config property "(.*)" (succeeds|fails)$`,
		crcCmd.UnsetConfigPropertySucceedsOrFails)
	s.Step(`^login to the oc cluster (succeeds|fails)$`,
		util.LoginToOcClusterSucceedsOrFails)
	s.Step(`^setting kubeconfig context to "(.*)" (succeeds|fails)$`,
		SetKubeConfigContextSucceedsOrFails)
	s.Step(`^with up to "(\d+)" retries with wait period of "(\d*(?:ms|s|m))" http response from "(.*)" has status code "(\d+)"$`,
		CheckHTTPResponseWithRetry)
	s.Step(`^with up to "(\d+)" retries with wait period of "(\d*(?:ms|s|m))" command "(.*)" output (should match|matches|should not match|does not match) "(.*)"$`,
		CheckOutputMatchWithRetry)
	s.Step(`^checking that CRC is (running|stopped)$`,
		CheckCRCStatus)
	s.Step(`^execut(?:e|ing) crc (.*) command$`,
		ExecuteCRCCommand)
	s.Step(`^execut(?:e|ing) crc (.*) command (.*)$`,
		ExecuteCommandWithExpectedExitStatus)
	s.Step(`^execut(?:e|ing) single crc (.*) command (.*)$`,
		ExecuteSingleCommandWithExpectedExitStatus)
	s.Step(`^execut(?:e|ing) podman command (.*) (succeeds|fails)$`,
		ExecutingPodmanCommandSucceedsFails)
	s.Step(`^ensuring CRC cluster is running$`,
		EnsureCRCIsRunning)
	s.Step(`^ensuring oc command is available$`,
		EnsureOCCommandIsAvailable)
	s.Step(`^ensuring user is logged in (succeeds|fails)`,
		EnsureUserIsLoggedIntoClusterSucceedsOrFails)
	s.Step(`^podman command is available$`,
		PodmanCommandIsAvailable)
	s.Step(`^deleting a pod (succeeds|fails)$`,
		DeletingPodSucceedsOrFails)
	s.Step(`^pulling image "(.*)", logging in, and pushing local image to internal registry succeeds$`,
		PullLoginTagPushImageSucceeds)

	// CRC file operations
	s.Step(`^file "([^"]*)" exists in CRC home folder$`,
		FileExistsInCRCHome)
	s.Step(`"(JSON|YAML)" config file "(.*)" in CRC home folder (contains|does not contain) key "(.*)" with value matching "(.*)"$`,
		ConfigFileInCRCHomeContainsKeyMatchingValue)
	s.Step(`"(JSON|YAML)" config file "(.*)" in CRC home folder (contains|does not contain) key "(.*)"$`,
		ConfigFileInCRCHomeContainsKey)
	s.Step(`removing file "(.*)" from CRC home folder succeeds$`,
		DeleteFileFromCRCHome)
	s.Step(`^decode base64 file "(.*)" to "(.*)"$`,
		DecodeBase64File)
	s.Step(`^ensuring network mode user$`,
		EnsureUserNetworkmode)
	s.Step(`^ensuring microshift cluster is fully operational$`,
		EnsureMicroshiftClusterIsOperational)

	s.After(func(ctx context.Context, sc *godog.Scenario, err error) (context.Context, error) {

		if usingPreexistingCluster() {
			// collecting diagnostics data is quite slow, and they
			// are not really useful when running the tests locally
			// against an already running cluster
			return ctx, nil
		}
		if err != nil {
			if err := util.RunDiagnose(filepath.Join("..", "test-results")); err != nil {
				fmt.Printf("Failed to collect diagnostic: %v\n", err)
			}
		}

		err = util.CloseHostShellInstance()
		if err != nil {
			fmt.Println("error closing host shell instance:", err)
		}

		return ctx, nil
	})
}

func usingPreexistingCluster() bool {
	return strings.Contains(GodogTags, "~@startstop")
}

func WaitForClusterInState(state string) error {
	return crcCmd.WaitForClusterInState(state)
}

func CheckHTTPResponseWithRetry(retryCount int, retryWait string, address string, expectedStatusCode int) error {
	var err error

	retryDuration, err := time.ParseDuration(retryWait)
	if err != nil {
		return err
	}

	tr := &http.Transport{
		// #nosec G402
		TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
	}
	client := &http.Client{Transport: tr}

	var resp *http.Response
	for i := 0; i < retryCount; i++ {
		resp, err = client.Get(address)
		if err == nil && resp.StatusCode == expectedStatusCode {
			return nil
		}
		time.Sleep(retryDuration)
	}

	if err != nil {
		return err
	}
	return fmt.Errorf("got %d as Status Code instead of expected %d", resp.StatusCode, expectedStatusCode)
}

func CheckOutputMatchWithRetry(retryCount int, retryTime string, command string, expected string, expectedOutput string) error {

	retryDuration, err := time.ParseDuration(retryTime)
	if err != nil {
		return err
	}

	var matchErr error

	for i := 0; i < retryCount; i++ {
		execErr := util.ExecuteCommand(command)
		if execErr == nil {
			if strings.Contains(expected, " not ") {
				matchErr = util.CommandReturnShouldNotMatch("stdout", expectedOutput)
			} else {
				matchErr = util.CommandReturnShouldMatch("stdout", expectedOutput)
			}
			if matchErr == nil {
				return nil
			}
		}
		time.Sleep(retryDuration)
	}

	return matchErr
}

func CommandReturnShouldContainCorrectVersion() error {

	if CRCVersion == "" {
		return util.CommandReturnShouldContain("stdout", "version:")
	}

	return util.CommandReturnShouldContain("stdout", CRCVersion)
}

func CheckCRCStatus(state string) error {
	if state == "running" {
		// crc start can finish successfully, even when
		// status for cluster is still starting. It is expected
		// the cluster got stabilized at most within 10 minutes
		return crcCmd.WaitForClusterInState(state)
	}
	return crcCmd.CheckCRCStatus(state)
}

func DeleteFileFromCRCHome(fileName string) error {

	theFile := filepath.Join(util.CRCHome, fileName)

	if _, err := os.Stat(theFile); os.IsNotExist(err) {
		return nil
	}

	if err := util.DeleteFile(theFile); err != nil {
		return fmt.Errorf("error deleting file %v", theFile)
	}
	return nil
}

func FileExistsInCRCHome(fileName string) error {

	theFile := filepath.Join(util.CRCHome, fileName)

	_, err := os.Stat(theFile)
	if os.IsNotExist(err) {
		return fmt.Errorf("file %s does not exists, error: %v ", theFile, err)
	}

	return err
}

func RemoveBundleFromCache(presetName string) error {

	var p preset.Preset

	if presetName == "podman" {
		p = preset.Podman
	} else {
		p = preset.OpenShift
	}

	theBundle := util.GetBundlePath(p)
	theFolder := strings.TrimSuffix(theBundle, ".crcbundle")

	// remove the unpacked folder (if present)
	err := os.RemoveAll(theFolder)
	if err != nil {
		return err
	}

	// remove the bundle file (if present)
	err = os.RemoveAll(theBundle)

	if err != nil {
		return err
	}

	return nil
}

func ConfigFileInCRCHomeContainsKeyMatchingValue(format string, configFile string, condition string, keyPath string, expectedValue string) error {

	if expectedValue == "current bundle" {
		if !userProvidedBundle {
			return ConfigFileInCRCHomeContainsKey("JSON", "crc.json", "does not contain", "bundle")
		}
		expectedValue = fmt.Sprintf(".*%s", bundleName)
	}
	configPath := filepath.Join(util.CRCHome, configFile)

	config, err := util.GetFileContent(configPath)
	if err != nil {
		return err
	}

	keyValue, err := util.GetConfigKeyValue([]byte(config), format, keyPath)
	if err != nil {
		return err
	}

	matches, err := util.PerformRegexMatch(expectedValue, keyValue)
	if err != nil {
		return err
	}
	if (condition == "contains") && !matches {
		return fmt.Errorf("for key '%s' config contains unexpected value '%s'", keyPath, keyValue)
	} else if (condition == "does not contain") && matches {
		return fmt.Errorf("for key '%s' config contains value '%s', which it should not contain", keyPath, keyValue)
	}
	return nil
}

func ConfigFileInCRCHomeContainsKey(format string, configFile string, condition string, keyPath string) error {

	configPath := filepath.Join(util.CRCHome, configFile)

	config, err := util.GetFileContent(configPath)
	if err != nil {
		return err
	}

	keyValue, err := util.GetConfigKeyValue([]byte(config), format, keyPath)
	if err != nil {
		return err
	}

	if (condition == "contains") && (keyValue == "<nil>") {
		return fmt.Errorf("config does not contain any value for key %s", keyPath)
	} else if (condition == "does not contain") && (keyValue != "<nil>") {
		return fmt.Errorf("config contains key %s with assigned value: %s", keyPath, keyValue)
	}

	return nil
}

func SetKubeConfigContextSucceedsOrFails(context, expected string) error {
	cmd := fmt.Sprintf("oc config use-context %s", context)
	return util.ExecuteCommandSucceedsOrFails(cmd, expected)
}

func StartCRCWithDefaultBundleSucceedsOrFails(expected string) error {

	var cmd string
	var extraBundleArgs string

	if userProvidedBundle {
		extraBundleArgs = fmt.Sprintf("-b %s", bundleLocation)
	}
	crcStart := crcCmd.CRC("start").ToString()
	cmd = fmt.Sprintf("%s -p '%s' %s", crcStart, pullSecretFile, extraBundleArgs)
	err := util.ExecuteCommandSucceedsOrFails(cmd, expected)

	return err
}

func StartCRCWithDefaultBundleWithStopNetworkTimeSynchronizationSucceedsOrFails(expected string) error {

	var cmd string
	var extraBundleArgs string

	if userProvidedBundle {
		extraBundleArgs = fmt.Sprintf("-b %s", bundleLocation)
	}
	crcStart := crcCmd.CRC("start").WithDisableNTP().ToString()
	cmd = fmt.Sprintf("%s -p '%s' %s", crcStart, pullSecretFile, extraBundleArgs)
	err := util.ExecuteCommandSucceedsOrFails(cmd, expected)

	return err
}

func StartCRCWithCustomBundleSucceedsOrFails(expected string) error {
	crcStart := crcCmd.CRC("start").ToString()
	cmd := fmt.Sprintf("%s -p '%s' -b *.crcbundle", crcStart, pullSecretFile)
	return util.ExecuteCommandSucceedsOrFails(cmd, expected)
}

func StartCRCWithDefaultBundleAndNameServerSucceedsOrFails(nameserver string, expected string) error {

	var extraBundleArgs string
	if userProvidedBundle {
		extraBundleArgs = fmt.Sprintf("-b %s", bundleLocation)
	}

	crcStart := crcCmd.CRC("start").ToString()
	cmd := fmt.Sprintf("%s -n %s -p '%s' %s", crcStart, nameserver, pullSecretFile, extraBundleArgs)
	return util.ExecuteCommandSucceedsOrFails(cmd, expected)
}

func EnsureCRCIsRunning() error {
	if usingPreexistingCluster() {
		return nil
	}

	err := crcCmd.CheckCRCStatus("running")

	// if cluster is not in a Running state
	if err != nil {
		// make sure cluster doesn't exist in unexpected state
		err = ExecuteCRCCommand("cleanup")
		if err != nil {
			return err
		}

		// set up and start the cluster with lots of memory, if specified
		if CRCMemory != "" {
			err = SetConfigPropertyToValueSucceedsOrFails("memory", CRCMemory, "succeeds")
			if err != nil {
				return err
			}
		}

		err = ExecuteSingleCommandWithExpectedExitStatus("setup", "succeeds") // uses the right bundle argument if needed
		if err != nil {
			return err
		}

		if runtime.GOOS == "windows" {
			err = StartCRCWithDefaultBundleAndNameServerSucceedsOrFails("10.75.5.25", "succeeds")
		} else {
			err = StartCRCWithDefaultBundleSucceedsOrFails("succeeds")
		}
		if err != nil {
			return err
		}

		// We're not testing if the cluster comes up fast enough, just need it Running
		err = crcCmd.WaitForClusterInState("running")
		if err != nil {
			err = crcCmd.WaitForClusterInState("running")
			if err != nil {
				return err
			}
		}

	}
	return nil
}

func EnsureUserIsLoggedIntoClusterSucceedsOrFails(expected string) error {

	if err := setOcEnv(); err != nil {
		return err
	}

	err := util.LoginToOcCluster([]string{})
	if expected == "succeeds" && err != nil && strings.Contains(err.Error(), "The server uses a certificate signed by unknown authority") {
		// do some logging

		err1 := util.ExecuteCommand("oc config view --raw -o jsonpath=\"{.clusters[?(@.name=='api-crc-testing:6443')].cluster.certificate-authority-data}\" > ca.base64")
		if err1 != nil {
			fmt.Println(err1)
		}
		err1 = DecodeBase64File("ca.base64", "ca.crt")
		if err1 != nil {
			fmt.Println(err1)
		}
		err1 = util.ExecuteCommand("echo QUIT | openssl s_client -connect api.crc.testing:6443 | openssl x509 -out server.crt")
		if err1 != nil {
			fmt.Println(err1)
		}
		err1 = util.ExecuteCommand("openssl verify -CAfile ca.crt server.crt")
		if err1 != nil {
			fmt.Println(err1)
		}

		// login with ignorance
		err = util.LoginToOcCluster([]string{"--insecure-skip-tls-verify"})
	}
	return err
}

func EnsureOCCommandIsAvailable() error {
	err := setOcEnv()
	if err != nil {
		return err
	}
	return setPodmanEnv()
}

func setOcEnv() error {
	if runtime.GOOS == "windows" {
		return util.ExecuteCommandSucceedsOrFails("crc oc-env | Invoke-Expression", "succeeds")
	}
	return util.ExecuteCommandSucceedsOrFails("eval $(crc oc-env)", "succeeds")
}

func setPodmanEnv() error {
	if runtime.GOOS == "windows" {
		return util.ExecuteCommandSucceedsOrFails("crc podman-env | Invoke-Expression", "succeeds")
	}
	return util.ExecuteCommandSucceedsOrFails("eval $(crc podman-env)", "succeeds")
}

func SetConfigPropertyToValueSucceedsOrFails(property string, value string, expected string) error {
	// Since network-mode is only supported on Linux, we skip this property test for non-linux platforms
	if property == "network-mode" && runtime.GOOS != "linux" {
		return nil
	}
	if value == "current bundle" {
		if !userProvidedBundle {
			value = filepath.Join(util.CRCHome, "cache", bundleName)
		} else {
			value = bundleLocation
		}
	}
	return crcCmd.SetConfigPropertyToValueSucceedsOrFails(property, value, expected)
}

func ExecuteCRCCommand(command string) error {
	return crcCmd.CRC(command).Execute()
}

func ExecuteCommandWithExpectedExitStatus(command string, expectedExitStatus string) error {
	if command == "setup" && userProvidedBundle {
		command = fmt.Sprintf("%s -b %s", command, bundleLocation)
	}
	return crcCmd.CRC(command).ExecuteWithExpectedExit(expectedExitStatus)
}

func ExecuteSingleCommandWithExpectedExitStatus(command string, expectedExitStatus string) error {
	if command == "setup" && userProvidedBundle {
		command = fmt.Sprintf("%s -b %s", command, bundleLocation)
	}
	return crcCmd.CRC(command).ExecuteSingleWithExpectedExit(expectedExitStatus)
}

func DeletingPodSucceedsOrFails(expected string) error {
	var err error
	if runtime.GOOS == "windows" {
		_ = util.ExecuteCommandSucceedsOrFails("$Env:POD = $(oc get pod -o jsonpath=\"{.items[0].metadata.name}\")", expected)
		err = util.ExecuteCommandSucceedsOrFails("oc delete pod $Env:POD --now", expected)
	} else {
		_ = util.ExecuteCommandSucceedsOrFails("POD=$(oc get pod -o jsonpath=\"{.items[0].metadata.name}\")", expected)
		err = util.ExecuteCommandSucceedsOrFails("oc delete pod $POD --now", expected)
	}
	return err
}

func PodmanCommandIsAvailable() error {

	// Do what 'eval $(crc podman-env) would do
	path := os.ExpandEnv("${HOME}/.crc/bin/podman:$PATH")
	csshk := os.ExpandEnv("${HOME}/.crc/machines/crc/id_ecdsa")
	dh := os.ExpandEnv("unix:///${HOME}/.crc/machines/crc/docker.sock")
	ch := "ssh://core@127.0.0.1:2222/run/user/1000/podman/podman.sock"
	if runtime.GOOS == "windows" {
		userHomeDir, _ := os.UserHomeDir()
		unexpandedPath := filepath.Join(userHomeDir, ".crc/bin/podman;${PATH}")
		path = os.ExpandEnv(unexpandedPath)
		csshk = filepath.Join(userHomeDir, ".crc/machines/crc/id_ecdsa")
		dh = "npipe:////./pipe/crc-podman"
	}
	if runtime.GOOS == "linux" {
		ch = "ssh://core@192.168.130.11:22/run/user/1000/podman/podman.sock"
	}

	os.Setenv("PATH", path)
	os.Setenv("CONTAINER_SSHKEY", csshk)
	os.Setenv("CONTAINER_HOST", ch)
	os.Setenv("DOCKER_HOST", dh)

	return nil

}

func ExecutingPodmanCommandSucceedsFails(command string, expected string) error {

	var err error
	if expected == "succeeds" {
		_, err = cmd.RunPodmanExpectSuccess(strings.Split(command[1:len(command)-1], " ")...)
	} else if expected == "fails" {
		_, err = cmd.RunPodmanExpectFail(strings.Split(command[1:len(command)-1], " ")...)
	}

	return err
}

func PullLoginTagPushImageSucceeds(image string) error {
	_, err := cmd.RunPodmanExpectSuccess("pull", image)
	if err != nil {
		return err
	}

	err = util.ExecuteCommand("oc whoami -t")
	if err != nil {
		return err
	}

	token := util.GetLastCommandOutput("stdout")
	fmt.Println(token)
	_, err = cmd.RunPodmanExpectSuccess("login", "-u", "kubeadmin", "-p", token, "default-route-openshift-image-registry.apps-crc.testing", "--tls-verify=false") // $(oc whoami -t)
	if err != nil {
		return err
	}

	_, err = cmd.RunPodmanExpectSuccess("tag", "quay.io/centos7/httpd-24-centos7", "default-route-openshift-image-registry.apps-crc.testing/testproj/hello:test")
	if err != nil {
		return err
	}

	_, err = cmd.RunPodmanExpectSuccess("push", "default-route-openshift-image-registry.apps-crc.testing/testproj/hello:test", "--tls-verify=false")
	if err != nil {
		return err
	}

	return nil
}

// Decode a file encoded with base64
func DecodeBase64File(inputFile, outputFile string) error {
	var cmd string
	if runtime.GOOS == "windows" {
		cmd = fmt.Sprintf("certutil.exe -decode %s %s", inputFile, outputFile)
	} else {
		cmd = fmt.Sprintf("base64 -d -i %s > %s", inputFile, outputFile)
	}
	return util.ExecuteCommandSucceedsOrFails(cmd, "succeeds")
}

func EnsureUserNetworkmode() error {
	if runtime.GOOS == "linux" {
		return crcCmd.SetConfigPropertyToValueSucceedsOrFails(
			"network-mode", "user", "succeeds")
	}
	return nil
}

// This function will wait until the microshift cluster got operational
func EnsureMicroshiftClusterIsOperational() error {
	// First wait until crc report the cluster as running
	err := crcCmd.WaitForClusterInState("running")
	if err != nil {
		return err
	}
	// Define the services to declare the cluster operational
	services := map[string]string{
		".*dns-default.*2/2.*Running.*":    "oc get pods -n openshift-dns",
		".*ovnkube-master.*4/4.*Running.*": "oc get pods -n openshift-ovn-kubernetes",
		".*ovnkube-node.*1/1.*Running.*":   "oc get pods -n openshift-ovn-kubernetes"}

	for operationalState, getPodCommand := range services {
		var operational = false
		for !operational {
			if err := util.ExecuteCommandSucceedsOrFails(getPodCommand, "succeeds"); err != nil {
				return err
			}
			operational = (nil == util.CommandReturnShouldMatch(
				"stdout",
				operationalState))
		}
	}

	return nil
}