[ForReview] Refactor otelzap tests

[pellared]

Reuse open-telemetry/opentelemetry-go#6342

Original assertion failures when I break 2 places:

--- FAIL: TestCore (0.00s)
    --- FAIL: TestCore/WithMultiple (0.00s)
        core_test.go:126: 
                Error Trace:    /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:126
                Error:          Not equal: 
                                expected: 3
                                actual  : 2
                Test:           TestCore/WithMultiple
        core_test.go:130: 
                Error Trace:    /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:130
                                                        /home/ropajak/go/pkg/mod/go.opentelemetry.io/otel/[email protected]/record.go:117
                                                        /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:129
                Error:          Not equal: 
                                expected: "test2"
                                actual  : "test3"
                            
                                Diff:
                                --- Expected
                                +++ Actual
                                @@ -1 +1 @@
                                -test2
                                +test3
                Test:           TestCore/WithMultiple
        core_test.go:131: 
                Error Trace:    /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:131
                                                        /home/ropajak/go/pkg/mod/go.opentelemetry.io/otel/[email protected]/record.go:117
                                                        /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:129
                Error:          Not equal: 
                                expected: "value2"
                                actual  : "value3"
                            
                                Diff:
                                --- Expected
                                +++ Actual
                                @@ -1 +1 @@
                                -value2
                                +value3
                Test:           TestCore/WithMultiple
        core_test.go:132: 
                Error Trace:    /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:132
                                                        /home/ropajak/go/pkg/mod/go.opentelemetry.io/otel/[email protected]/record.go:117
                                                        /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:129
                Error:          Not equal: 
                                expected: "value2"
                                actual  : "value3"
                            
                                Diff:
                                --- Expected
                                +++ Actual
                                @@ -1 +1 @@
                                -value2
                                +value3
                Test:           TestCore/WithMultiple
--- FAIL: TestCoreWithCaller (0.00s)
    core_test.go:185: 
                Error Trace:    /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:185
                                                        /home/ropajak/go/pkg/mod/go.opentelemetry.io/otel/[email protected]/record.go:117
                                                        /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:176
                Error:          Not equal: 
                                expected: "go.opentelemetry.io/BAD/bridges/otelzap"
                                actual  : "go.opentelemetry.io/contrib/bridges/otelzap"
                            
                                Diff:
                                --- Expected
                                +++ Actual
                                @@ -1 +1 @@
                                -go.opentelemetry.io/BAD/bridges/otelzap
                                +go.opentelemetry.io/contrib/bridges/otelzap
                Test:           TestCoreWithCaller
FAIL
exit status 1
FAIL    go.opentelemetry.io/contrib/bridges/otelzap     0.006s

Here is how assertion failures looks after the changes:

-- FAIL: TestCore (0.00s)
   --- FAIL: TestCore/WithMultiple (0.00s)
        /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:165: recording mismatch (-want +got):
              logtest.Recording{
              	{Name: "name"}: {
              		{
              			... // 2 ignored and 3 identical fields
              			SeverityText: "info",
              			Body:         s"log message",
              			Attributes: []log.KeyValue(Inverse(cmpopts.SortSlices, []log.KeyValue{
            - 				s"a:b",
              				s"fizz:buzz",
              				s"foo:bar",
              			})),
              		},
              	},
              }
            
--- FAIL: TestCoreWithCaller (0.00s)
    /home/ropajak/repos/opentelemetry-go-contrib/bridges/otelzap/core_test.go:257: "code.namespace" attribute has bad value, got = go.opentelemetry.io/contrib/bridges/otelzap, want = "go.opentelemetry.io/BAD/bridges/otelzap"

Personally, I also find the tests more readable and easier to maintain. For instance, check the current version of WithMultiple.

@scorpionknifes, @dmathieu, can you take a look and give feedback if you think if it is an improvement?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.1%. Comparing base (89cbae1) to head (a114036).

Additional details and impacted files

@@          Coverage Diff          @@
##            main   #6839   +/-   ##
=====================================
  Coverage   76.1%   76.1%           
=====================================
  Files        219     219           
  Lines      21313   21313           
=====================================
  Hits       16221   16221           
  Misses      4531    4531           
  Partials     561     561           

[pellared]

@khushijain21, can you also take a look as a code owner?

[khushijain21]

The new logtest design looks great! and I agree it makes it more readable. LGTM