टेस्ट करना

संग्रह की मदद से व्यवस्थित रहें अपनी प्राथमिकताओं के आधार पर, कॉन्टेंट को सेव करें और कैटगरी में बांटें.
समस्या की शिकायत करें स्रोत देखें

Bazel में Starlark कोड की जांच करने के कई तरीके हैं. यह पेज, उपयोग के उदाहरण के मुताबिक मौजूदा सबसे सही तरीके और फ़्रेमवर्क इकट्ठा करता है.

जांच के नियम

Skylib का एक टेस्ट फ़्रेमवर्क है, जिसे unittest.bzl कहा जाता है. इसकी मदद से, नियमों और कार्रवाइयों के विश्लेषण के समय का आकलन किया जाता है, जैसे कि उनकी सेवाएं देने वाली कंपनियां और डेवलपर. ऐसे टेस्ट को "विश्लेषण टेस्ट" कहा जाता है. फ़िलहाल, ये टेस्ट, नियमों के अंदरूनी कामकाज की जांच करने का सबसे अच्छा विकल्प हैं.

कुछ चेतावनियां:

  • टेस्ट के दावे बिल्ड में होते हैं, न कि अलग रनर रनर प्रोसेस में. टेस्ट के लिए बनाए गए टारगेट का नाम इस तरह होना चाहिए कि वे अन्य टेस्ट या बिल्ड के टारगेट से मेल न खाएं. टेस्ट के दौरान होने वाली गड़बड़ी को बैज को टेस्ट फ़ेल होने के बजाय, बिल्ड ब्रेकेज के तौर पर दिखता है.

  • टेस्ट के तहत बनाए गए नियमों और टेस्ट के दावों वाले नियमों को सेट अप करने के लिए, बॉयलरप्लेट की काफ़ी मात्रा की ज़रूरत होती है. शुरुआत में यह बॉयलरप्लेट मुश्किल लग सकता है. इससे इस बात का ध्यान रखने में मदद मिलती है कि लोड होने के दौरान मैक्रो का मूल्यांकन और टारगेट किया जाता है, जबकि नियम लागू करने के फ़ंक्शन, विश्लेषण के दौरान बाद में नहीं चलते.

  • विश्लेषण टेस्ट का मकसद काफ़ी छोटा और हल्का है. विश्लेषण टेस्ट करने के फ़्रेमवर्क की कुछ सुविधाएं, ज़्यादा से ज़्यादा ट्रांज़िटिव डिपेंडेंसी वाले टारगेट की पुष्टि करने तक सीमित हैं (फ़िलहाल, 500 हैं). इसकी वजह यह है कि इन सुविधाओं का इस्तेमाल बड़े पैमाने पर किया जाता है.

बुनियादी सिद्धांत यह है कि वह एक ऐसा टेस्ट नियम तय करे जो नियम-से-टेस्ट पर निर्भर करता है. इससे नियम-टेस्ट की सेवा देने वाली कंपनियों को जांच के नियम का ऐक्सेस मिल जाता है.

जांच करने के नियम लागू करने की प्रक्रिया में दावे किए जाते हैं. अगर कोई गड़बड़ी होती है, तो इन्हें fail() पर कॉल करने पर तुरंत सूचना मिल जाती है (जो विश्लेषण के समय होने वाली गड़बड़ी को ट्रिगर करती है), लेकिन इसे जनरेट की गई स्क्रिप्ट में सेव नहीं किया जाता जो टेस्ट के चलने के समय काम नहीं करती.

नीचे एक छोटा टॉय उदाहरण देखें. इसके बाद एक उदाहरण दिया गया है, जो कार्रवाइयों की जांच करता है.

कम से कम उदाहरण

//mypkg/myrules.bzl:

MyInfo = provider(fields = {
    "val": "string value",
    "out": "output File",
})

def _myrule_impl(ctx):
    """Rule that just generates a file and returns a provider."""
    out = ctx.actions.declare_file(ctx.label.name + ".out")
    ctx.actions.write(out, "abc")
    return [MyInfo(val="some value", out=out)]

myrule = rule(
    implementation = _myrule_impl,
)

//mypkg/myrules_test.bzl:

load("@bazel_skylib//lib:unittest.bzl", "asserts", "analysistest")
load(":myrules.bzl", "myrule", "MyInfo")

# ==== Check the provider contents ====

def _provider_contents_test_impl(ctx):
    env = analysistest.begin(ctx)

    target_under_test = analysistest.target_under_test(env)
    # If preferred, could pass these values as "expected" and "actual" keyword
    # arguments.
    asserts.equals(env, "some value", target_under_test[MyInfo].val)

    # If you forget to return end(), you will get an error about an analysis
    # test needing to return an instance of AnalysisTestResultInfo.
    return analysistest.end(env)

# Create the testing rule to wrap the test logic. This must be bound to a global
# variable, not called in a macro's body, since macros get evaluated at loading
# time but the rule gets evaluated later, at analysis time. Since this is a test
# rule, its name must end with "_test".
provider_contents_test = analysistest.make(_provider_contents_test_impl)

# Macro to setup the test.
def _test_provider_contents():
    # Rule under test. Be sure to tag 'manual', as this target should not be
    # built using `:all` except as a dependency of the test.
    myrule(name = "provider_contents_subject", tags = ["manual"])
    # Testing rule.
    provider_contents_test(name = "provider_contents_test",
                           target_under_test = ":provider_contents_subject")
    # Note the target_under_test attribute is how the test rule depends on
    # the real rule target.

# Entry point from the BUILD file; macro for running each test case's macro and
# declaring a test suite that wraps them together.
def myrules_test_suite(name):
    # Call all test functions and wrap their targets in a suite.
    _test_provider_contents()
    # ...

    native.test_suite(
        name = name,
        tests = [
            ":provider_contents_test",
            # ...
        ],
    )

//mypkg/BUILD:

load(":myrules.bzl", "myrule")
load(":myrules_test.bzl", "myrules_test_suite")

# Production use of the rule.
myrule(
    name = "mytarget",
)

# Call a macro that defines targets that perform the tests at analysis time,
# and that can be executed with "bazel test" to return the result.
myrules_test_suite(name = "myrules_test")

टेस्ट को bazel test //mypkg:myrules_test की मदद से चलाया जा सकता है.

शुरुआती load() स्टेटमेंट के अलावा, फ़ाइल के दो मुख्य हिस्से होते हैं:

  • खुद से जांच में, इनमें से हर जांच में 1) जांच के नियम को लागू करने के लिए, उसका विश्लेषण करने का तरीका, 2) analysistest.make() की मदद से जांच करने के नियम का एलान करना, और 3) नियम को टेस्ट करने का नियम और जांच करने के नियम लागू करना शामिल है. अगर दावे, टेस्ट केस के बीच नहीं बदलते हैं, तो 1) और 2) कई टेस्ट केस से शेयर किए जा सकते हैं.

  • टेस्ट सुइट फ़ंक्शन, जो हर टेस्ट के लिए, कॉन्टेंट लोड होने में लगने वाले समय के फ़ंक्शन को कॉल करता है. साथ ही, test_suite टारगेट को सभी टेस्ट को एक साथ बंडल करने का एलान करता है.

समानता के लिए, सुझाया गया नाम रखने का तरीका अपनाएं: foo को जांच के नाम वाले उस हिस्से के लिए बने रहने दें जो बताता है कि जांच में क्या जांच की जा रही है (ऊपर दिए गए उदाहरण में provider_contents). उदाहरण के लिए, JUnit टेस्ट का तरीका testFooनाम दिया जाएगा.

इसके बाद:

  • जो मैक्रो, टेस्ट के लिए टेस्ट और टारगेट जनरेट करता है उसका नाम _test_foo (_test_provider_contents) होना चाहिए

  • इसकी जांच करने के नियम का नाम foo_test (provider_contents_test) होना चाहिए

  • इस तरह के नियम का लेबल foo_test होना चाहिए (provider_contents_test)

  • टेस्टिंग नियम लागू करने के फ़ंक्शन का नाम _foo_test_impl होना चाहिए (_provider_contents_test_impl)

  • टेस्ट में मौजूद नियमों के टारगेट के लेबल और उनकी डिपेंडेंसी के शुरू में foo_ (provider_contents_) होना चाहिए

ध्यान दें कि सभी टारगेट के लेबल, एक ही बिल्ड पैकेज में मौजूद दूसरे लेबल से मेल नहीं खा सकते. इसलिए, टेस्ट के लिए खास नाम का इस्तेमाल करना मददगार होता है.

टेस्ट नहीं हो सका

नियम की मदद से इस बात की पुष्टि की जा सकती है कि कोई नियम, कुछ इनपुट या किसी खास स्थिति में लागू नहीं हो पा रहा है. विश्लेषण के जांच फ़्रेमवर्क का इस्तेमाल करके ऐसा किया जा सकता है:

analysistest.make के साथ बनाए गए टेस्ट के नियम में expect_failure दर्ज होना चाहिए:

failure_testing_test = analysistest.make(
    _failure_testing_test_impl,
    expect_failure = True,
)

जांच के लिए नियम लागू करने से, यह बताया जाना चाहिए कि कार्रवाई में कितनी गड़बड़ी हुई है (खास तौर पर, गड़बड़ी का मैसेज):

def _failure_testing_test_impl(ctx):
    env = analysistest.begin(ctx)
    asserts.expect_failure(env, "This rule should never work")
    return analysistest.end(env)

यह भी पक्का करें कि जांच में शामिल आपके टारगेट को खास तौर पर 'मैन्युअल' के तौर पर टैग किया गया हो. इसके बिना, :all का इस्तेमाल करके अपने पैकेज में सभी टारगेट बनाने का मतलब है कि जान-बूझकर टारगेट नहीं बनाया जा सकेगा. 'मैन्युअल' की मदद से, 'टेस्ट' के लिए बना आपका टारगेट सिर्फ़ तब बनाया जाएगा, जब उसे साफ़ तौर पर बताया गया हो या वह गैर-मैन्युअल टारगेट (जैसे कि आपके टेस्ट के नियम) पर निर्भर करता हो:

def _test_failure():
    myrule(name = "this_should_fail", tags = ["manual"])

    failure_testing_test(name = "failure_testing_test",
                         target_under_test = ":this_should_fail")

# Then call _test_failure() in the macro which generates the test suite and add
# ":failure_testing_test" to the suite's test targets.

रजिस्टर की गई कार्रवाइयों की पुष्टि की जा रही है

आपके पास ऐसे टेस्ट लिखने की सुविधा है जो आपके नियम के ज़रिए की जाने वाली कार्रवाइयों पर दावा करते हों. जैसे, ctx.actions.run() का इस्तेमाल करना. यह आपके विश्लेषण विश्लेषण नियम लागू करने के फ़ंक्शन में किया जा सकता है. एक उदाहरण:

def _inspect_actions_test_impl(ctx):
    env = analysistest.begin(ctx)

    target_under_test = analysistest.target_under_test(env)
    actions = analysistest.target_actions(env)
    asserts.equals(env, 1, len(actions))
    action_output = actions[0].outputs.to_list()[0]
    asserts.equals(
        env, target_under_test.label.name + ".out", action_output.basename)
    return analysistest.end(env)

ध्यान दें कि analysistest.target_actions(env), Action ऑब्जेक्ट की सूची दिखाता है. ये ऑब्जेक्ट, टेस्ट के तहत टारगेट से रजिस्टर की गई कार्रवाइयों को दिखाते हैं.

अलग-अलग फ़्लैग में नियम के व्यवहार की पुष्टि करना

हो सकता है कि आप यह पुष्टि करना चाहें कि कोई नियम, तय किए गए बिल्ड फ़्लैग के मुताबिक काम करता हो. उदाहरण के लिए, अगर कोई उपयोगकर्ता ये चीज़ें बताता है, तो आपका नियम अलग तरह से काम कर सकता है:

bazel build //mypkg:real_target -c opt

बनाम

bazel build //mypkg:real_target -c dbg

मनचाहे बिल्ड के फ़्लैग का इस्तेमाल करके, पहली बार में टारगेट की जांच करके ऐसा किया जा सकता है:

bazel test //mypkg:myrules_test -c opt

लेकिन उसके बाद आपके टेस्ट सुइट में एक ऐसा टेस्ट शामिल नहीं किया जा सकता जो -c opt के तहत नियम के व्यवहार की पुष्टि करता हो और दूसरा टेस्ट, जो -c dbg के तहत नियम के व्यवहार की पुष्टि करता है. दोनों टेस्ट एक ही बिल्ड में नहीं चल पाएंगे!

टेस्ट के नियम तय करते समय, इसे तय किए गए बिल्ड फ़्लैग के ज़रिए बताया जा सकता है:

myrule_c_opt_test = analysistest.make(
    _myrule_c_opt_test_impl,
    config_settings = {
        "//command_line_option:compilation_mode": "opt",
    },
)

आम तौर पर, मौजूदा बिल्ड फ़्लैग को ध्यान में रखते हुए, टेस्ट में मौजूद किसी टारगेट का विश्लेषण किया जाता है. config_settings के बारे में बताने से बताई गई कमांड लाइन के विकल्पों की वैल्यू बदल जाती है. (कोई भी तय नहीं किया गया विकल्प अपनी वैल्यू को वास्तविक कमांड लाइन से बनाए रखेगा.

दिए गए config_settings शब्दकोश में, कमांड लाइन फ़्लैग को खास प्लेसहोल्डर वैल्यू //command_line_option: के साथ लगाया जाना चाहिए, जैसा कि ऊपर दिखाया गया है.

आर्टफ़ैक्ट की पुष्टि की जा रही है

आपकी जनरेट की गई फ़ाइलें सही हैं या नहीं, इसकी जांच करने के मुख्य तरीके ये हैं:

  • आप शेल, Python या किसी दूसरी भाषा में टेस्ट स्क्रिप्ट लिख सकते हैं. साथ ही, सही *_test नियम टाइप का टारगेट बना सकते हैं.

  • आपको जिस तरह का टेस्ट करना है उसके लिए किसी खास नियम का इस्तेमाल किया जा सकता है.

टेस्ट टारगेट का इस्तेमाल करना

आर्टफ़ैक्ट की पुष्टि करने का सबसे आसान तरीका, एक स्क्रिप्ट लिखना और अपनी BUILD फ़ाइल में *_test टारगेट जोड़ना है. आपको जिन खास आर्टफ़ैक्ट को देखना है वे इस टारगेट के लिए डेटा पर निर्भर करने वाले मॉडल होने चाहिए. अगर आपकी पुष्टि करने वाले तर्क का इस्तेमाल एक से ज़्यादा जांचों के लिए किया जा सकता है, तो यह ऐसी स्क्रिप्ट होनी चाहिए जो कमांड लाइन आर्ग्युमेंट लेती हो. ये टेस्ट टारगेट की args विशेषता से कंट्रोल होते हैं. यहां एक उदाहरण दिया गया है, जिससे इस बात की पुष्टि होती है कि myrule का आउटपुट "abc" है.

//mypkg/myrule_validator.sh:

if [ "$(cat $1)" = "abc" ]; then
  echo "Passed"
  exit 0
else
  echo "Failed"
  exit 1
fi

//mypkg/BUILD:

...

myrule(
    name = "mytarget",
)

...

# Needed for each target whose artifacts are to be checked.
sh_test(
    name = "validate_mytarget",
    srcs = [":myrule_validator.sh"],
    args = ["$(location :mytarget.out)"],
    data = [":mytarget.out"],
)

कस्टम नियम का उपयोग करना

शेल स्क्रिप्ट को टेंप्लेट के तौर पर लिखना ज़्यादा आसान विकल्प है. इससे नए नियम को इंस्टैंशिएट किया जा सकता है. इसमें ज़्यादा सीधे तौर पर नहीं दिखाया जाने वाला तरीका और स्टारलार्क लॉजिक शामिल है, लेकिन इससे बिल्ड फ़ाइलें भी साफ़ हो जाती हैं. इससे होने वाले फ़ायदे के तौर पर, किसी भी आर्ग्युमेंट को पहले से प्रोसेस करने के लिए, स्क्रिप्ट के बजाय Starlark का इस्तेमाल किया जा सकता है. साथ ही, स्क्रिप्ट में खुद से दस्तावेज़ बनाने की सुविधा भी थोड़ी ज़्यादा होती है, क्योंकि इसमें अंकों वाले प्लेसहोल्डर के बजाय सिंबलिक प्लेसहोल्डर का इस्तेमाल किया जाता है.

//mypkg/myrule_validator.sh.template:

if [ "$(cat %TARGET%)" = "abc" ]; then
  echo "Passed"
  exit 0
else
  echo "Failed"
  exit 1
fi

//mypkg/myrule_validation.bzl:

def _myrule_validation_test_impl(ctx):
  """Rule for instantiating myrule_validator.sh.template for a given target."""
  exe = ctx.outputs.executable
  target = ctx.file.target
  ctx.actions.expand_template(output = exe,
                              template = ctx.file._script,
                              is_executable = True,
                              substitutions = {
                                "%TARGET%": target.short_path,
                              })
  # This is needed to make sure the output file of myrule is visible to the
  # resulting instantiated script.
  return [DefaultInfo(runfiles=ctx.runfiles(files=[target]))]

myrule_validation_test = rule(
    implementation = _myrule_validation_test_impl,
    attrs = {"target": attr.label(allow_single_file=True),
             # You need an implicit dependency in order to access the template.
             # A target could potentially override this attribute to modify
             # the test logic.
             "_script": attr.label(allow_single_file=True,
                                   default=Label("//mypkg:myrule_validator"))},
    test = True,
)

//mypkg/BUILD:

...

myrule(
    name = "mytarget",
)

...

# Needed just once, to expose the template. Could have also used export_files(),
# and made the _script attribute set allow_files=True.
filegroup(
    name = "myrule_validator",
    srcs = [":myrule_validator.sh.template"],
)

# Needed for each target whose artifacts are to be checked. Notice that you no
# longer have to specify the output file name in a data attribute, or its
# $(location) expansion in an args attribute, or the label for the script
# (unless you want to override it).
myrule_validation_test(
    name = "validate_mytarget",
    target = ":mytarget",
)

इसके अलावा, आप टेंप्लेट एक्सपैंशन कार्रवाई का इस्तेमाल करने के बजाय, टेंप्लेट को .bzl फ़ाइल में एक स्ट्रिंग के तौर पर इनलाइन कर सकते हैं. साथ ही, str.format मैथड या %-फ़ॉर्मैटिंग का इस्तेमाल करके, विश्लेषण के चरण के दौरान इसे बड़ा कर सकते हैं.

Starlark की उपयोगिताओं की जांच करना

Skylib के unittest.bzl फ़्रेमवर्क का इस्तेमाल, उपयोगिता से जुड़े फ़ंक्शन की जांच करने के लिए किया जा सकता है. इसका मतलब है कि वे फ़ंक्शन जो न तो मैक्रो में लागू होते हैं और न ही लागू करने के तरीके में. unittest.bzl की analysistest लाइब्रेरी का इस्तेमाल करने के बजाय, unittest का इस्तेमाल किया जा सकता है. ऐसे टेस्ट सुइट के लिए, unittest.suite() फ़ंक्शन का इस्तेमाल करके बॉयलरप्लेट को कम किया जा सकता है.

//mypkg/myhelpers.bzl:

def myhelper():
    return "abc"

//mypkg/myhelpers_test.bzl:

load("@bazel_skylib//lib:unittest.bzl", "asserts", "unittest")
load(":myhelpers.bzl", "myhelper")

def _myhelper_test_impl(ctx):
  env = unittest.begin(ctx)
  asserts.equals(env, "abc", myhelper())
  return unittest.end(env)

myhelper_test = unittest.make(_myhelper_test_impl)

# No need for a test_myhelper() setup function.

def myhelpers_test_suite(name):
  # unittest.suite() takes care of instantiating the testing rules and creating
  # a test_suite.
  unittest.suite(
    name,
    myhelper_test,
    # ...
  )

//mypkg/BUILD:

load(":myhelpers_test.bzl", "myhelpers_test_suite")

myhelpers_test_suite(name = "myhelpers_tests")

ज़्यादा उदाहरणों के लिए, Skylib की खुद की जांच देखें.