< Summary

Class:Azure.Storage.Internal.Avro.AvroReader
Assembly:Azure.Storage.Blobs
File(s):C:\Git\azure-sdk-for-net\sdk\storage\Azure.Storage.Internal.Avro\src\AvroReader.cs
Covered lines:42
Uncovered lines:38
Coverable lines:80
Total lines:255
Line coverage:52.5% (42 of 80)
Covered branches:19
Total branches:38
Branch coverage:50% (19 of 38)

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
get_BlockOffset()-100%100%
get_ObjectIndex()-100%100%
.ctor(...)-77.78%50%
.ctor(...)-0%0%
.ctor()-0%100%
Initalize()-75%50%
HasNext()-100%100%
Next()-80.95%80%
Dispose()-0%100%
Dispose(...)-0%0%

File(s)

C:\Git\azure-sdk-for-net\sdk\storage\Azure.Storage.Internal.Avro\src\AvroReader.cs

#LineLine coverage
 1// Copyright (c) Microsoft Corporation. All rights reserved.
 2// Licensed under the MIT License.
 3
 4using System;
 5using System.Collections.Generic;
 6using System.IO;
 7using System.Linq;
 8using System.Threading.Tasks;
 9using System.Text.Json;
 10using System.Threading;
 11
 12namespace Azure.Storage.Internal.Avro
 13{
 14    internal class AvroReader : IDisposable
 15    {
 16        /// <summary>
 17        /// Stream containing the body of the Avro file.
 18        /// </summary>
 19        private readonly Stream _dataStream;
 20
 21        /// <summary>
 22        /// Stream containing the header of the Avro file.
 23        /// </summary>
 24        private readonly Stream _headerStream;
 25
 26        /// <summary>
 27        /// Sync marker.
 28        /// </summary>
 29        private byte[] _syncMarker;
 30
 31        /// <summary>
 32        /// Avro metadata.
 33        /// </summary>
 34        private Dictionary<string, string> _metadata;
 35
 36        /// <summary>
 37        /// Avro schema.
 38        /// </summary>
 39        private AvroType _itemType;
 40
 41        /// <summary>
 42        /// The number of items remaining in the current block.
 43        /// </summary>
 44        private long _itemsRemainingInBlock;
 45
 46        /// <summary>
 47        /// The byte offset within the Avro file (both header and data)
 48        /// of the start of the current block.
 49        /// </summary>
 21650        public virtual long BlockOffset { get; private set; }
 51
 52        /// <summary>
 53        /// The index of the current object within the current block.
 54        /// </summary>
 55        /// <returns></returns>
 44856        public virtual long ObjectIndex { get; private set; }
 57
 58        /// <summary>
 59        /// If this Avro Reader has been initalized.
 60        /// </summary>
 61        private bool _initalized;
 62
 63        /// <summary>
 64        /// To detect redundant calls
 65        /// </summary>
 66        private bool _disposed = false;
 67
 68        /// <summary>
 69        /// Remembers where we started if partial data stream was provided.
 70        /// </summary>
 71        private readonly long _initialBlockOffset;
 72
 73        /// <summary>
 74        /// Constructor for an AvroReader that will read from the
 75        /// beginning of an Avro file.
 76        /// </summary>
 9077        public AvroReader(Stream dataStream)
 78        {
 9079            if (dataStream.CanSeek)
 80            {
 9081                _dataStream = dataStream;
 9082                _headerStream = dataStream;
 83            }
 84            else
 85            {
 086                _dataStream = new StreamWithPosition(dataStream);
 087                _headerStream = _dataStream;
 88            }
 89
 9090            _metadata = new Dictionary<string, string>();
 9091            _initalized = false;
 9092        }
 93
 94        /// <summary>
 95        /// Constructor for an Avro Reader that will read beginning
 96        /// in the middle of an Avro file.
 97        /// </summary>
 098        public AvroReader(
 099            Stream dataStream,
 0100            Stream headerStream,
 0101            long currentBlockOffset,
 0102            long indexWithinCurrentBlock)
 103        {
 0104            if (dataStream.CanSeek)
 105            {
 0106                _dataStream = dataStream;
 107            }
 108            else
 109            {
 0110                _dataStream = new StreamWithPosition(dataStream);
 111            }
 112
 0113            if (headerStream.CanSeek)
 114            {
 0115                _headerStream = headerStream;
 116            }
 117            else
 118            {
 0119                _headerStream = new StreamWithPosition(headerStream);
 120            }
 121
 0122            _metadata = new Dictionary<string, string>();
 0123            _initalized = false;
 0124            _initialBlockOffset = currentBlockOffset;
 0125            BlockOffset = currentBlockOffset;
 0126            ObjectIndex = indexWithinCurrentBlock;
 0127            _initalized = false;
 0128        }
 129
 130        /// <summary>
 131        /// Constructor for mocking.  Do not use.
 132        /// </summary>
 0133        public AvroReader() { }
 134
 135        public virtual async Task Initalize(bool async, CancellationToken cancellationToken = default)
 136        {
 137            // Four bytes, ASCII 'O', 'b', 'j', followed by 1.
 40138            byte[] header = await AvroParser.ReadFixedBytesAsync(_headerStream, AvroConstants.InitBytes.Length, async, c
 40139            if (!header.SequenceEqual(AvroConstants.InitBytes))
 140            {
 0141                throw new ArgumentException("Stream is not an Avro file.");
 142            }
 143
 144            // File metadata is written as if defined by the following map schema:
 145            // { "type": "map", "values": "bytes"}
 40146            _metadata = await AvroParser.ReadMapAsync(_headerStream, AvroParser.ReadStringAsync, async, cancellationToke
 147
 148            // Validate codec
 40149            _metadata.TryGetValue(AvroConstants.CodecKey, out string codec);
 40150            if (!(codec == null || codec == "null"))
 151            {
 0152                throw new ArgumentException("Codecs are not supported");
 153            }
 154
 155            // The 16-byte, randomly-generated sync marker for this file.
 40156            _syncMarker = await AvroParser.ReadFixedBytesAsync(_headerStream, AvroConstants.SyncMarkerSize, async, cance
 157
 158            // Parse the schema
 40159            using JsonDocument schema = JsonDocument.Parse(_metadata[AvroConstants.SchemaKey]);
 40160            _itemType = AvroType.FromSchema(schema.RootElement);
 161
 40162            if (BlockOffset == 0)
 163            {
 40164                BlockOffset = _initialBlockOffset + _dataStream.Position;
 165            }
 166
 167            // Populate _itemsRemainingInCurrentBlock
 40168            _itemsRemainingInBlock = await AvroParser.ReadLongAsync(_dataStream, async, cancellationToken).ConfigureAwai
 169
 170            // skip block length
 40171            await AvroParser.ReadLongAsync(_dataStream, async, cancellationToken).ConfigureAwait(false);
 172
 40173            _initalized = true;
 174
 40175            if (ObjectIndex > 0)
 176            {
 0177                for (int i = 0; i < ObjectIndex; i++)
 178                {
 0179                    await _itemType.ReadAsync(_dataStream, async, cancellationToken).ConfigureAwait(false);
 0180                    _itemsRemainingInBlock--;
 181                }
 182            }
 40183        }
 184
 216185        public virtual bool HasNext() => !_initalized || _itemsRemainingInBlock > 0;
 186
 187        public virtual async Task<object> Next(bool async, CancellationToken cancellationToken = default)
 188        {
 189            // Initialize AvroReader, if necessary.
 136190            if (!_initalized)
 191            {
 40192                await Initalize(async, cancellationToken).ConfigureAwait(false);
 193            }
 194
 136195            if (!HasNext())
 196            {
 0197                throw new ArgumentException("There are no more items in the stream");
 198            }
 199
 200
 136201            object result = await _itemType.ReadAsync(_dataStream, async, cancellationToken).ConfigureAwait(false);
 202
 136203            _itemsRemainingInBlock--;
 136204            ObjectIndex++;
 205
 136206            if (_itemsRemainingInBlock == 0)
 207            {
 136208                byte[] marker = await AvroParser.ReadFixedBytesAsync(_dataStream, 16, async, cancellationToken).Configur
 209
 136210                BlockOffset = _initialBlockOffset + _dataStream.Position;
 136211                ObjectIndex = 0;
 212
 136213                if (!_syncMarker.SequenceEqual(marker))
 214                {
 0215                    throw new ArgumentException("Stream is not a valid Avro file.");
 216                }
 217
 218                try
 219                {
 136220                    _itemsRemainingInBlock = await AvroParser.ReadLongAsync(_dataStream, async, cancellationToken).Confi
 136221                }
 0222                catch (InvalidOperationException)
 223                {
 224                    // We hit the end of the stream.
 0225                }
 226
 136227                if (_itemsRemainingInBlock > 0)
 228                {
 229                    // Ignore block size
 96230                    await AvroParser.ReadLongAsync(_dataStream, async, cancellationToken).ConfigureAwait(false);
 231                }
 232            }
 233
 136234            return result;
 136235        }
 236
 0237        public void Dispose() => Dispose(true);
 238
 239        protected virtual void Dispose(bool disposing)
 240        {
 0241            if (_disposed)
 242            {
 0243                return;
 244            }
 245
 0246            if (disposing)
 247            {
 0248                _dataStream.Dispose();
 0249                _headerStream.Dispose();
 250            }
 251
 0252            _disposed = true;
 0253        }
 254    }
 255}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:05 PM
GitHub | www.palmmedia.de

Methods/Properties

get_BlockOffset()
get_ObjectIndex()
.ctor(...)
.ctor(...)
.ctor()
Initalize()
HasNext()
Next()
Dispose()
Dispose(...)