// Copyright 2021 Google Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package java

import (
 "sort"
 "strings"

 "android/soong/android"
 "android/soong/cc"
 "android/soong/fuzz"

 "github.com/google/blueprint"
 "github.com/google/blueprint/proptools"
)

//go:generate go run ../../blueprint/gobtools/codegen

const (
 hostString   = "host"
 targetString = "target"
 deviceString = "device"
)

// Any shared libs for these deps will also be packaged
var artDeps = []string{"libdl_android"}

func init() {
 RegisterJavaFuzzBuildComponents(android.InitRegistrationContext)
}

func RegisterJavaFuzzBuildComponents(ctx android.RegistrationContext) {
 ctx.RegisterModuleType("java_fuzz", JavaFuzzFactory)
 ctx.RegisterParallelSingletonType("java_fuzz_packaging", javaFuzzPackagingFactory)
}

type JavaFuzzTest struct {
 Test
 fuzzPackagedModule fuzz.FuzzPackagedModule
 jniFilePaths       android.Paths
}

// @auto-generate: gob
type JavaFuzzTestInfo struct {
 JniFilePaths android.Paths
}

var JavaFuzzTestInfoProvider = blueprint.NewProvider[JavaFuzzTestInfo]()

// java_fuzz builds and links sources into a `.jar` file for the device.
// This generates .class files in a jar which can then be instrumented before
// fuzzing in Android Runtime (ART: Android OS on emulator or device)
func JavaFuzzFactory() android.Module {
 module := &JavaFuzzTest{}

 module.addHostAndDeviceProperties()
 module.AddProperties(&module.testProperties)
 module.AddProperties(&module.fuzzPackagedModule.FuzzProperties)

 module.Module.properties.Installable = proptools.BoolPtr(true)
 module.Module.dexpreopter.isTest = true
 module.Module.linter.properties.Lint.Test_module_type = proptools.BoolPtr(true)
 module.Module.sourceProperties.Test_only = proptools.BoolPtr(true)
 module.Module.sourceProperties.Top_level_test_target = true

 android.AddLoadHook(module, func(ctx android.LoadHookContext) {
  disableLinuxBionic := struct {
   Target struct {
    Linux_bionic struct {
     Enabled *bool
    }
   }
  }{}
  disableLinuxBionic.Target.Linux_bionic.Enabled = proptools.BoolPtr(false)
  ctx.AppendProperties(&disableLinuxBionic)
 })

 InitJavaModuleMultiTargets(module, android.HostAndDeviceSupported)
 return module
}

func (j *JavaFuzzTest) DepsMutator(ctx android.BottomUpMutatorContext) {
 if j.Os().Class.String() == deviceString {
  j.testProperties.Jni_libs.AppendSimpleValue(artDeps)
 }

 jniLibs := j.testProperties.Jni_libs.GetOrDefault(ctx, nil)
 if len(jniLibs) > 0 {
  if j.fuzzPackagedModule.FuzzProperties.Fuzz_config == nil {
   config := &fuzz.FuzzConfig{}
   j.fuzzPackagedModule.FuzzProperties.Fuzz_config = config
  }
  // this will be used by the ingestion pipeline to determine the version
  // of jazzer to add to the fuzzer package
  j.fuzzPackagedModule.FuzzProperties.Fuzz_config.IsJni = proptools.BoolPtr(true)
  for _, target := range ctx.MultiTargets() {
   sharedLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"})
   ctx.AddFarVariationDependencies(sharedLibVariations, jniLibTag, jniLibs...)
  }
 }

 j.deps(ctx)
}

func (j *JavaFuzzTest) GenerateAndroidBuildActions(ctx android.ModuleContext) {
 j.fuzzPackagedModule = cc.PackageFuzzModule(ctx, j.fuzzPackagedModule)

 _, jniPairs := cc.CollectAllSharedDependencies(ctx)
 for _, jni := range jniPairs {
  libPath := android.PathForModuleOut(ctx, jni.Dst)
  ctx.Build(pctx, android.BuildParams{
   Rule:   android.CpRule,
   Input:  jni.Src,
   Output: libPath,
  })
  j.jniFilePaths = append(j.jniFilePaths, libPath)
 }

 checkMinSdkVersionMts(ctx, j.MinSdkVersion(ctx))
 j.Test.generateAndroidBuildActionsWithConfig(ctx, nil)

 var compatibilitySupportFiles android.Paths
 compatibilitySupportFiles = append(compatibilitySupportFiles, j.implementationJarFile)
 compatibilitySupportFiles = append(compatibilitySupportFiles, j.jniFilePaths...)
 compatibilitySupportFiles = append(compatibilitySupportFiles, j.fuzzPackagedModule.Corpus...)
 if j.fuzzPackagedModule.Dictionary != nil {
  compatibilitySupportFiles = append(compatibilitySupportFiles, j.fuzzPackagedModule.Dictionary)
 }

 ctx.SetTestSuiteInfo(android.TestSuiteInfo{
  TestSuites:                j.testProperties.Test_suites,
  MainFile:                  j.outputFile,
  MainFileStem:              j.Stem(),
  MainFileExt:               ".jar",
  ConfigFile:                j.testConfig,
  ExtraConfigs:              j.extraTestConfigs,
  NeedsArchFolder:           ctx.Device(),
  CompatibilitySupportFiles: compatibilitySupportFiles,
  PerTestcaseDirectory:      proptools.Bool(j.testProperties.Per_testcase_directory),
  IsUnitTest:                proptools.Bool(j.testProperties.Test_options.Unit_test),
 })

 fuzzModuleValidator := fuzz.FuzzModule{
  j.ModuleBase,
  j.DefaultableModuleBase,
  j.ApexModuleBase,
 }

 if fuzz.IsValid(ctx, fuzzModuleValidator) {
  fuzz.SetFuzzPackagedModuleInfo(ctx, &j.fuzzPackagedModule)
  android.SetProvider(ctx, JavaFuzzTestInfoProvider, JavaFuzzTestInfo{
   JniFilePaths: j.jniFilePaths,
  })
 }
}

type javaFuzzPackager struct {
 fuzz.FuzzPackager
}

func javaFuzzPackagingFactory() android.Singleton {
 return &javaFuzzPackager{}
}

func (s *javaFuzzPackager) GenerateBuildActions(ctx android.SingletonContext) {
 // Map between each architecture + host/device combination.
 archDirs := make(map[fuzz.ArchOs][]fuzz.FileToZip)

 s.FuzzTargets = make(map[string]bool)
 ctx.VisitAllModuleProxies(func(module android.ModuleProxy) {
  // Discard non-fuzz targets.
  javaInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
  if !ok {
   return
  }
  fuzzInfo, ok := android.OtherModuleProvider(ctx, module, fuzz.FuzzPackagedModuleInfoProvider)
  if !ok {
   return
  }
  javaFuzzTestInfo, ok := android.OtherModuleProvider(ctx, module, JavaFuzzTestInfoProvider)
  if !ok {
   return
  }

  commonInfo := android.OtherModuleProviderOrDefault(ctx, module, android.CommonModuleInfoProvider)

  hostOrTargetString := "target"
  if commonInfo.Target.HostCross {
   hostOrTargetString = "host_cross"
  } else if commonInfo.Host {
   hostOrTargetString = "host"
  }

  archString := commonInfo.Target.Arch.ArchType.String()
  archDir := android.PathForIntermediates(ctx, "fuzz", hostOrTargetString, archString)
  archOs := fuzz.ArchOs{HostOrTarget: hostOrTargetString, Arch: archString, Dir: archDir.String()}

  var files []fuzz.FileToZip
  builder := android.NewRuleBuilder(pctx, ctx).SandboxDisabled()

  // Package the artifacts (data, corpus, config and dictionary) into a zipfile.
  files = s.PackageArtifacts(ctx, module, &fuzzInfo, archDir, builder)

  // Add .jar
  if !commonInfo.Host {
   for _, jar := range javaInfo.ImplementationJars {
    files = append(files, fuzz.FileToZip{SourceFilePath: jar, DestinationPathPrefix: "classes"})
   }
  }

  outputFile := android.OutputFileForModule(ctx, module, "")
  files = append(files, fuzz.FileToZip{SourceFilePath: outputFile})

  // Add jni .so files
  for _, fPath := range javaFuzzTestInfo.JniFilePaths {
   files = append(files, fuzz.FileToZip{SourceFilePath: fPath})
  }

  archDirs[archOs], ok = s.BuildZipFile(ctx, module, &fuzzInfo, files, builder, archDir, archString, hostOrTargetString, archOs, archDirs)
  if !ok {
   return
  }
 })
 s.CreateFuzzPackage(ctx, archDirs, fuzz.Java, pctx)

 // Create the phony and dist rules
 ctx.Phony("haiku-java", s.Packages...)
 ctx.DistForGoals([]string{"haiku-java"}, s.Packages...)
 for _, target := range android.SortedKeys(s.FuzzTargets) {
  ctx.Phony("haiku-java", android.PathForPhony(ctx, target))
 }

}

func (s *javaFuzzPackager) MakeVars(ctx android.MakeVarsContext) {
 packages := s.Packages.Strings()
 sort.Strings(packages)
 ctx.Strict("SOONG_JAVA_FUZZ_PACKAGING_ARCH_MODULES", strings.Join(packages, " "))
 // Preallocate the slice of fuzz targets to minimize memory allocations.
 s.PreallocateSlice(ctx, "ALL_JAVA_FUZZ_TARGETS")
}